01 / HANDOFF PRINCIPLE
เอกสารส่งต่อที่ดีต้องทำให้คนใหม่เริ่มงานได้
Handoff ไม่ใช่การ dump ทุกอย่างลงไฟล์ แต่คือการตอบคำถามที่คนรับช่วงต้องใช้ตัดสินใจ: งานนี้มีเป้าหมายอะไร, ตอนนี้อยู่ตรงไหน, ไฟล์ไหนคือ source of truth, ตรวจอย่างไร และอะไรยังเป็นความเสี่ยง
Context
ทำไมงานนี้เกิดขึ้น และข้อจำกัดอะไรที่ห้ามละเมิด
Current state
สิ่งที่เสร็จแล้ว, สิ่งที่ยังค้าง และหลักฐานล่าสุด
How to verify
คำสั่ง test, route, browser flow หรือ screenshot ที่ใช้ยืนยัน
Next move
ขั้นตอนถัดไปที่เล็กพอให้คนรับช่วงเริ่มได้ทันที
02 / WHAT IS DOCMD
docmd ทำหน้าที่อะไร
docmd เป็น documentation engine แบบ zero-config ที่อ่าน Markdown แล้วสร้าง static documentation site พร้อม navigation, search, SEO และ AI context. จุดเด่นสำหรับ handoff คือเอกสารยังเป็นไฟล์ Markdown ธรรมดา จึง review ด้วย Git และแก้ด้วย editor ใดก็ได้
- ใช้กับโฟลเดอร์ Markdown ที่มีอยู่แล้ว ไม่จำเป็นต้องเปลี่ยนไปใช้ React หรือ Vue
- มี local full-text search และสร้าง
llms.txt/llms-full.txtเพื่อเป็น context ให้ agent - มี native MCP server สำหรับให้ agent search, read และ validate เอกสารจาก local workspace
- รองรับ callout, tabs, cards, Mermaid, OpenAPI, versioning และ deployment ผ่าน configuration เมื่อจำเป็น
03 / QUICK START
ติดตั้งและ preview เอกสาร
เริ่มในโฟลเดอร์ที่มี Markdown. docmd จะตรวจโฟลเดอร์เอกสารหรือไฟล์ .md แล้วสร้าง navigation ให้. ถ้าพอร์ต 3000 ถูกใช้อยู่ ให้ระบุพอร์ตใหม่หรือใช้พอร์ตที่ CLI เลือกให้อัตโนมัติ
cd /path/to/documentation
# dev preview + watch files
npx @docmd/core dev
# build static site
npx @docmd/core build
# ผลลัพธ์เริ่มต้นอยู่ที่
./site/อย่าเริ่มจากการทำหน้าเว็บสำหรับเอกสารเองถ้ายังไม่มีปัญหาเรื่อง layout. ให้เขียน Markdown ให้โครงสร้างดี แล้วค่อยเพิ่ม docmd.config.js เมื่อจำเป็นต้องกำหนด theme, output, version หรือ plugin
04 / HANDOFF TEMPLATE
โครงสร้าง doc ที่คนอื่นเปิดแล้วไปต่อได้
แยกเอกสารตามคำถาม ไม่ใช่ตามคนเขียน. ใช้ชื่อไฟล์ที่บอกลำดับการอ่าน และเก็บ decision ที่ย้อนกลับยากไว้เป็นเอกสารเฉพาะ
docs/
├── 00-overview.md # เป้าหมาย, audience, scope
├── 01-current-state.md # สิ่งที่เสร็จและหลักฐานล่าสุด
├── 02-architecture.md # โครงสร้างระบบและ contract
├── 03-runbook.md # คำสั่ง dev, test, deploy, rollback
├── 04-decisions.md # decision และ trade-off ที่สำคัญ
├── 05-handoff.md # งานค้าง, owner, next steps, blockers
└── assets/ # ภาพประกอบและไฟล์ที่อ้างอิง# Handoff: เพิ่มหน้า blog article
## Goal
เพิ่มบทความ 3 route โดยไม่เพิ่มรายการใน navbar
## Current state
- Routes: /blog/opencode-opendesign, /blog/obsidian, /blog/docmd
- npm run lint: pass
- npm run build: pass
## Files changed
- src/components/Blog/ArticleShell.tsx
- src/app/blog/opencode-opendesign/page.tsx
## Verify
1. เปิดแต่ละ route ใน browser
2. ตรวจ console และ mobile horizontal overflow
3. ตรวจ metadata และ external source links
## Next steps
- เพิ่ม article index ถ้าต้องการให้ค้นพบจาก /blog
- ตรวจเนื้อหาและอัปเดต source links ก่อน deploy05 / DOCUMENTATION LOOP
ส่งต่อแบบตรวจสอบได้
- เขียนพร้อมโค้ด: ทุก feature ที่เปลี่ยน behavior ต้องอัปเดต overview, runbook หรือ decision ที่เกี่ยวข้อง
- ตรวจจาก clean checkout: ให้คนรับช่วงทำตามคำสั่งใน doc โดยไม่พึ่งความจำของผู้เขียน
- สร้าง site: รัน docmd dev เพื่ออ่านเหมือนผู้ใช้ และ docmd build เพื่อตรวจ output
- ส่งต่อหลักฐาน: แนบ commit/branch, test output, URL, known issues และ next step ที่มี owner
ใช้ docmd ตรวจเอกสารใน docs/ นี้
ตรวจว่า navigation อ่านตามลำดับได้
ค้นคำว่า "Current state", "Verify", "Next steps" ในทุก handoff
ตรวจ broken links, code command ที่ไม่ตรงกับ package.json และ secret ที่เผลอหลุด
สรุปไฟล์ที่ขาดข้อมูล พร้อมเสนอ patch เฉพาะเอกสาร
ห้ามแก้ source code และห้าม deploy จนกว่าจะได้รับอนุญาตOfficial references