Document Service
Generate comprehensive documentation for IntexuraOS services.
Usage
code
/document-service # List available services (discovery mode) /document-service <service-name> # Document service interactively
Autonomous mode: Use Task tool with subagent_type: service-scribe for batch documentation without user interaction.
Core Mandates
- •Code-First Analysis: Always analyze actual code before generating docs
- •Preserve User Insights: Never lose user-provided context from previous runs
- •Incremental Updates: Website content updates are additive, not full regenerations
- •Quality Assurance: Self-critique before writing files to disk
- •Debt Tracking: Archive resolved items, never delete history
Output Files
Each service produces 5 documentation files:
| File | Purpose | Audience |
|---|---|---|
features.md | Value propositions, capabilities, use cases | Users, marketing |
technical.md | Architecture, APIs, patterns, gotchas | Developers, AI agents |
tutorial.md | Getting-started tutorial with exercises | New developers |
technical-debt.md | Known issues, debt items, future plans | Maintainers |
agent.md | Machine-readable interface (autonomous only) | AI agents |
Plus website content updates:
| File | Purpose |
|---|---|
services/index.md | Service catalog |
site-marketing.md | Marketing pages source |
site-developer.md | Developer docs source |
site-index.json | Structured metadata |
overview.md | Project narrative |
Mode Selection
| Mode | When to Use | Invocation |
|---|---|---|
| Discovery | List services, check doc status | /document-service (no args) |
| Interactive | Document one service with user input | /document-service <service-name> |
| Autonomous | Batch document all/multiple services | Task tool → service-scribe |
Invocation Detection
| Input Pattern | Workflow |
|---|---|
/document-service | discovery.md |
/document-service <service> | interactive.md |
Task tool service-scribe subagent | autonomous.md |
References
- •Workflows:
workflows/ - •Templates:
templates/ - •Reference:
reference/