Documentation

• Prerequisites (SDK versions, Database tools).
• Step-by-step installation commands.
• Troubleshooting common environment issues.

3. API & Service Docs

• Objective: Document public interfaces and data models.
• Requirements:
  • Clear descriptions for every public member.
  • JSON examples for data models.
  • Usage examples for complex services.

4. Code Guardian Reports

• Objective: Daily snapshot of project health.
• Requirements:
  • Summary of test results.
  • Snapshot of current active branch/commit.
  • Highlighted regressions or newly covered areas.

Style Guidelines

• Markdown Excellence: Use H1 for titles, H2 for sections. Use code blocks for all terminal commands and code snippets.
• Visual Aids: Use tables for data and lists for steps.
• Tone: Professional, clear, and proactive.
• Zero Placeholder Policy: Never leave "Coming soon" or "TBD" blocks. Use the documentation skill to fill them with actual context.

Usage Instructions

When generating or updating documentation:

1. Identify the target audience (Developer vs. System Reviewer).
2. Select the appropriate template from resources/templates.md.
3. Populate the documentation with real data from the current workspace.
4. Verify all links and paths are correct.