وكيل Technical Writer
يكتب وكيل Technical Writer وثائق المستخدم الخاصة بتغيير ما أو يحدّثها. ويختتم سير العمل Feature SDLC، فتصبح مسودته أيضا ملخص الجلسة.
وكيل Technical Writer يكتب للأشخاص الذين سيستخدمون التغيير. يصوغ وثائق جديدة موجهة إلى المستخدمين، أو يحدّث الموجود منها، لتطلق الميزة ومعها شرح لها.
أين يعمل
| سير العمل | الخطوة |
|---|---|
| Feature SDLC | User docs |
إنه الخطوة الثامنة والأخيرة في Feature SDLC. ويلي الخطوات التي تنفذ الميزة، فيعمل بعد كتابة الكود وتشغيل اختبارات المشروع. وحينها يكون لدى الجلسة متطلبات من وكيل Product Analyst، وتصميم تقني من وكيل Architect، وتغيير الواجهة الخلفية والأمامية كما كتب، وسيناريوهات شاملة من البداية إلى النهاية، ومراجعة أمنية. فيوثق الكاتب ما بني فعلا.
ولأنه يعمل أخيرا، تصبح مخرجاته أيضا ملخص الجلسة في صفحة الجلسة، مكتوبا بعد تشغيل الاختبارات.
المدخلات
- مهمة الجلسة.
- لقطة للقراءة فقط من ملفات مستودع المشروع، مختارة لصلتها بالمهمة.
- الخطوات السبع السابقة كلها، مختصرة لتتسع.
- التغيير كما كتب (فروقات تقتطع لتتسع حين تطول، مع وسم موضع الاقتطاع) ونتيجة الاختبار المسجلة.
المخرجات
مسودة وثائق نصية: صفحات أو أقسام جديدة، وتعديلات على الموجودة، والموضع المناسب لكل منها. وهي مكتوبة لمستخدمي المنتج، لا للمهندسين الذين بنوه.
يكون الكود قد كتب حين تعمل هذه الخطوة، فلا تتحول المسودة إلى ملفات في الجلسة نفسها. ولا تتضمن الفروقات وثائق إلا إذا كتبتها جولة كتابة الكود، مثلا لأن المهمة طلبت دليلا. ولإدخال المسودة إلى المستودع، أرسل طلب متابعة يطلبها ملفات.
مثال على تشغيل
مثال توضيحي، وليس جلسة مسجلة. لميزة الإعدادات المسبقة للمرشحات، يضيف وكيل Technical Writer قسما بعنوان «العروض المحفوظة» إلى دليل التصفية الموجود. يشرح فيه كيف يحفظ المستخدم المرشحات الحالية، وكيف يطبق عرضا محفوظا، وكيف يحذفه؛ وأن العروض المحفوظة شخصية؛ وأن لها حدا قدره 20. ويضيف سطرا واحدا إلى مسودة سجل التغييرات، وينبه إلى أن صورة شاشة قديمة في الدليل لن تعود مطابقة حين يظهر الزر.
الحدود
- لا يستطيع التقاط صور للشاشة ولا التحقق من شكل الميزة.
- يوثق التغيير من الفروقات التي تعرض عليه، والفروقات الطويلة تقتطع لتتسع. طابق المسودة مع الفروقات كاملة.
- مسودته لا تكتب في التغيير. ولا تدخل الوثائق طلب السحب إلا إذا كتبتها جولة كتابة الكود، أو عبر طلب متابعة.
- لا يستخدم أي سير عمل مضمّن اليوم وكيل Docs Writer المنفصل الموجود في فهرس لوحة التحكم.
الأسئلة الشائعة
هل تكون الوثائق التي يصوغها في طلب السحب؟
ليس من هذه الخطوة. فهي تعمل بعد كتابة الكود، فتبقى مسودته نصا في صفحة الجلسة. ولا تتضمن الفروقات وثائق إلا إذا كتبتها جولة كتابة الكود، مثلا لأن المهمة طلبت دليلا. ولإضافة المسودة ملفات، أرسل طلب متابعة.
هل يستطيع اتباع أسلوب وثائقنا؟
يقرأ الملفات الموجودة في مستودعك، فيميل إلى مجاراتها. وللقواعد الأكثر صرامة، استبدل تعليماته بوكيل مخصص باسم Technical Writer.