Automatic Technical Documentation
From code comment to API doc to architecture diagram—finish coding doc langsung siap
Documentation hole ini, siapa trenggilis siapa tahu
Kode ubah 20 kali, README masih 3 bulan yang lalu version. Newbie join liat doc, follow ikutin semua error, tanya baru tahu "oh doc itu already outdated".
Nggak seorang pun mau tulis doc. Dev bilang "kode itu doc", product bilang "lo tulis dulu gw liat", akhirnya nobody tulis, depend on word-of-mouth.
Good luck tulis API doc, launch ubah dua field lupa sync, frontend colleague opposite old doc tune seharian, datang lo bayaran.
Let OpenClaw handle documentation thing
OpenClaw direct read source code lo—function signature, parameter type, return value, comment, call relationship, semuanya analyze, terus generate structured doc.
Bukan "function ini terima satu parameter" jenis wasteful doc. Dia write clear tiap interface purpose, parameter explain, return example, error code, semua harus ada.
Code update? Run Prompt lagi, doc auto-update. Nggak perlu worry doc sama code out-of-sync.
Doc generate Prompt, langsung pake
Dari README sampai API doc sampai architecture diagram, tiga Prompt semua done.
Analyze complete project code structure, generate professional README.md.
Include section:
1. Project intro: satu-dua kalimat project purpose
2. Feature: bullet point core functionality
3. Quick start: install, config, run step (must copy-paste ready)
4. Project structure: directory tree + brief explain tiap directory
5. Config explain: environment variable, config file explain
6. API brief explain (kalo ada)
7. FAQ
Style: concise clear, no wasteful word. Example code must complete runnable.Read all API route/controller file di project.
Buat tiap interface generate standard API doc (Markdown format), include:
1. Interface path dan request method (GET/POST/PUT/DELETE)
2. Functionality: interface ini buat apa
3. Request parameter: parameter name, type, required apa nggak, explain, example value
4. Request body example (JSON format)
5. Response example: success dan failure return
6. Error code explain
7. Auth requirement (kalo perlu token)
Group per module, add navigation menu.Analyze complete project code structure sama module dependency.
Generate Mermaid diagram:
1. System architecture (flowchart):
- Show main module dan interaction
- Mark data flow direction
- Differentiate frontend, backend, database, third-party service
2. Module dependency (flowchart):
- Show code module import/dependency relationship
- Mark core module sama utility module
3. Data flow (sequenceDiagram):
- Show one core business complete request chain
- Dari user action sampai database sampai return
Each diagram include text explain, explain key design decision.Doc generate: OpenClaw vs ChatGPT
Sama-sama bisa generate doc, tapi completely different way.
- Direct read project source code, doc based on real code
- Understand file reference relationship, API doc accurate complete
- Code update regenerate, doc auto-sync
- Support generate Mermaid architecture diagram, sequence diagram
- Need manual copy-paste code, context limited
- Nggak see complete project structure, easy miss interface
- Generated doc one-time, code update harus re-paste
- Large project code exceed token limit, nggak bisa process one time