Skip to content
← सभी स्पेक दस्तावेज़

दस्तावेज़ीकरण मानक

संस्करण 1.0. यह मानक परिभाषित करता है कि Deep Work Plans अपनी संरचना, कार्यों और प्रगति का दस्तावेज़ीकरण कैसे करती हैं। यह DWP पद्धति के अंतर्गत बनाई गई हर योजना पर लागू होता है। कीवर्ड MUST, SHOULD और MAY का उपयोग RFC 2119 में परिभाषित अनुसार किया जाता है।

योजना README

हर योजना के पास एक README.md MUST हो जिसमें शामिल हो:

  • शीर्षक# Deep Work Plan: <name>
  • लक्ष्य — योजना के उद्देश्य का एक गद्य कथन।
  • स्रोत-सामग्री — विहित इनपुट के लिंक या पाथ (वैकल्पिक)।
  • कार्य — कार्य संख्या, नाम, और एक स्थिति चेकबॉक्स वाली एक markdown तालिका।
  • स्थिति<n>/<total> tasks complete रूप में एक पंक्ति।

कार्य फ़ाइलें

हर कार्य फ़ाइल का नाम <n>.task_<slug>.md MUST हो और इसमें नौ-खंड संरचना हो।

PROGRESS.md

PROGRESS.md एक केवल-जोड़ने योग्य निष्पादन लॉग है। हर प्रविष्टि को MUST दर्ज करना चाहिए:

  • एक ISO 8601 टाइमस्टैम्प।
  • कार्य संख्या और नाम।
  • क्या किया गया।
  • कोई विचलन या छोड़ने के कारण।

स्थिति-चिह्न

  • [ ] — शुरू नहीं हुआ।
  • [~] — प्रगति में।
  • [x] — पूर्ण।
  • [!] — अवरुद्ध।

शीर्षक

सभी शीर्षक वाक्य-केस का उपयोग MUST करें। दस्तावेज़ विपणन भाषा और विस्मयादिबोधक चिह्नों से बचें SHOULD।

दो अनिवार्य अंतिम कार्य

हर योजना दो मानक कार्यों के साथ समाप्त होनी MUST:

  1. Skills & Agents Discovery — बनाई गई पुनः-प्रयोज्य स्किल्स और एजेंट्स की पहचान करें।
  2. Executive Report — हितधारकों के लिए परिणामों का एक सारांश।