سندنویسی فنی
Technical documentationسند بد از نبودِ سند بدتر است، چون به آن اعتماد میکنی و دروغ میگوید. نوشتن سند خوب یک مهارت مهندسی است، نه کار اداری: باید بدانی مخاطب کیست، چه تصمیمی میخواهد بگیرد، و چه چیزی را میشود حذف کرد. این مسیر انواع سند را با نمونهٔ واقعی نشان میدهد و در هرکدام میگوید چه چیزی را ننویسی.
پیشرفت تو
درصد هر فصل از دو چیز میآید: چقدر از بخشهایش را خواندهای (۵۵٪) و چند تمرینش را تیک زدهای (۴۵٪). همهچیز داخل مرورگر خودت میماند.
فصل
فصلها به هم وابستهاند و ترتیبشان معنا دارد. هر مسیر با پروژههای نهایی تمام میشود: ساده، متوسط، پیچیده.
چرا سند
هزینهٔ ننوشتن، و هزینهٔ زیاد نوشتن.
در نوبت نوشتنمخاطب و هدف
برای که مینویسی و او چه تصمیمی دارد.
در نوبت نوشتناستخراج نیاز
مصاحبه، سؤال درست و نیاز پنهان.
در نوبت نوشتنSRS
سند نیازمندی نرمافزار: ساختار، نیاز کارکردی و غیرکارکردی.
در نوبت نوشتنداستان و معیار پذیرش
سبک چابک در برابر SRS سنگین.
در نوبت نوشتنUML ساختاری
نمودار کلاس، مؤلفه و استقرار.
در نوبت نوشتنUML رفتاری
use case، توالی، فعالیت و وضعیت.
در نوبت نوشتنBPMN
مدلسازی فرایند کسبوکار: رویداد، فعالیت، دروازه و lane.
در نوبت نوشتنBPMS
از نمودار تا فرایند اجراشدنی: Camunda و مانند آن.
در نوبت نوشتنC4 و ADR
سند معماری: زمینه تا کد، و ثبت تصمیم.
در نوبت نوشتنمستند API
OpenAPI، مثال، خطا و نسخه.
در نوبت نوشتنREADME و راهنمای کاربر
اولین سؤال خواننده را اول جواب بده.
در نوبت نوشتنRFC و طرح فنی
پیشنهاد تغییر بزرگ، و گرفتن بازخورد قبل از کد.
در نوبت نوشتننمودار خوب
Mermaid، PlantUML و قاعدههای خوانایی.
در نوبت نوشتننگهداشتن سند زنده
سندی که با کد بهروز میماند، نه سندی که میپوسد.
در نوبت نوشتنپروژهٔ ۱ — SRS یک سامانهٔ کوچک
از مصاحبه تا سند کامل.
در نوبت نوشتنپروژهٔ سادهپروژهٔ ۲ — مدلسازی فرایند با BPMN
یک فرایند سازمانی واقعی.
در نوبت نوشتنپروژهٔ متوسطپروژهٔ ۳ — بستهٔ سند معماری
C4، ADR، مستند API و README.
در نوبت نوشتنپروژهٔ پیچیده