Document Service
Generate comprehensive documentation for IntexuraOS services (apps, workers, and packages).
Usage
/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.
Team mode: Orchestrate parallel documentation agents for full monorepo coverage with cross-validation.
Core Mandates
- Code-First Analysis: Always analyze actual code before generating docs
- No Fabrication: Never invent version numbers, endpoints, env vars, resource limits, line counts, or method names — only document what exists in source code. See
workflows/autonomous.md Phase 3.5 for grounding rules
- 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 — includes mandatory factual validation (Phase 4.5)
- Debt Tracking: Archive resolved items, never delete history
- Cross-Validation: After generation, validate docs against code and other service docs
- Typographic Consistency: Use em-dashes (
—) not ASCII double-dashes (--) for parenthetical statements
Output Files
Per Service (apps/workers) — 5 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 |
Per Package -- 3 files
| File |
Purpose |
Audience |
README.md |
Overview, API, dependencies, usage |
Developers |
technical-debt.md |
Known issues, debt items, future plans |
Maintainers |
agent.md |
Machine-readable interface |
AI agents |
Aggregation files
| File |
Purpose |
services/index.md |
Service catalog |
site-index.json |
Structured metadata |
overview.md |
Project narrative |
documentation-runs.md |
Run history log |
Cross-Validation reports
| File |
Purpose |
validation/http-contracts-*.md |
HTTP endpoint consistency |
validation/pubsub-contracts-*.md |
Pub/Sub topic/IAM consistency |
validation/ai-models-*.md |
AI model registry consistency |
validation/firestore-*.md |
Collection ownership consistency |
validation/package-deps-*.md |
Package dependency consistency |
validation/env-vars-*.md |
Environment variable consistency |
validation/v*-run-report.md |
Comprehensive run report |
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 one/few services |
Task tool -> service-scribe |
| Team |
Full monorepo docs + cross-validation |
Orchestrate parallel agents (see team.md) |
Invocation Detection
| Input Pattern |
Workflow |
/document-service |
discovery.md |
/document-service <service> |
interactive.md |
Task tool service-scribe subagent |
autonomous.md |
| "Document all services" / team mode |
team.md |
| "Validate docs" / "cross-validate" |
cross-validation.md |
References
- Workflows:
workflows/
- Templates:
templates/
- Reference:
reference/
Converted and distributed by TomeVault — claim your Tome and manage your conversions.
1---2name: document-service3description: Generate professional documentation for IntexuraOS services (apps, workers, packages). Produces 5 doc files per service, 3 per package, plus aggregated site content and cross-validation reports. Supports interactive, autonomous, and team-of-agents modes. Use when documenting services, generating docs, updating documentation, or validating doc consistency. Use when this capability is needed.4---56# Document Service78Generate comprehensive documentation for IntexuraOS services (apps, workers, and packages).910## Usage1112```13/document-service # List available services (discovery mode)14/document-service <service-name> # Document service interactively15```1617**Autonomous mode:** Use Task tool with `subagent_type: service-scribe` for batch documentation without user interaction.1819**Team mode:** Orchestrate parallel documentation agents for full monorepo coverage with cross-validation.2021## Core Mandates22231. **Code-First Analysis**: Always analyze actual code before generating docs242. **No Fabrication**: Never invent version numbers, endpoints, env vars, resource limits, line counts, or method names — only document what exists in source code. See `workflows/autonomous.md` Phase 3.5 for grounding rules253. **Preserve User Insights**: Never lose user-provided context from previous runs264. **Incremental Updates**: Website content updates are additive, not full regenerations275. **Quality Assurance**: Self-critique before writing files to disk — includes mandatory factual validation (Phase 4.5)286. **Debt Tracking**: Archive resolved items, never delete history297. **Cross-Validation**: After generation, validate docs against code and other service docs308. **Typographic Consistency**: Use em-dashes (`—`) not ASCII double-dashes (`--`) for parenthetical statements3132## Output Files3334### Per Service (apps/workers) — 5 files3536| File | Purpose | Audience |37| ------------------- | -------------------------------------------- | --------------------- |38| `features.md` | Value propositions, capabilities, use cases | Users, marketing |39| `technical.md` | Architecture, APIs, patterns, gotchas | Developers, AI agents |40| `tutorial.md` | Getting-started tutorial with exercises | New developers |41| `technical-debt.md` | Known issues, debt items, future plans | Maintainers |42| `agent.md` | Machine-readable interface (autonomous only) | AI agents |4344### Per Package -- 3 files4546| File | Purpose | Audience |47| ------------------- | -------------------------------------- | ----------- |48| `README.md` | Overview, API, dependencies, usage | Developers |49| `technical-debt.md` | Known issues, debt items, future plans | Maintainers |50| `agent.md` | Machine-readable interface | AI agents |5152### Aggregation files5354| File | Purpose |55| ----------------------- | ------------------- |56| `services/index.md` | Service catalog |57| `site-index.json` | Structured metadata |58| `overview.md` | Project narrative |59| `documentation-runs.md` | Run history log |6061### Cross-Validation reports6263| File | Purpose |64| ---------------------------------- | -------------------------------- |65| `validation/http-contracts-*.md` | HTTP endpoint consistency |66| `validation/pubsub-contracts-*.md` | Pub/Sub topic/IAM consistency |67| `validation/ai-models-*.md` | AI model registry consistency |68| `validation/firestore-*.md` | Collection ownership consistency |69| `validation/package-deps-*.md` | Package dependency consistency |70| `validation/env-vars-*.md` | Environment variable consistency |71| `validation/v*-run-report.md` | Comprehensive run report |7273## Mode Selection7475| Mode | When to Use | Invocation |76| ----------- | ------------------------------------- | ----------------------------------------- |77| Discovery | List services, check doc status | `/document-service` (no args) |78| Interactive | Document one service with user input | `/document-service <service-name>` |79| Autonomous | Batch document one/few services | Task tool -> `service-scribe` |80| Team | Full monorepo docs + cross-validation | Orchestrate parallel agents (see team.md) |8182## Invocation Detection8384| Input Pattern | Workflow |85| ----------------------------------- | ---------------------------------------------------- |86| `/document-service` | [discovery.md](workflows/discovery.md) |87| `/document-service <service>` | [interactive.md](workflows/interactive.md) |88| Task tool `service-scribe` subagent | [autonomous.md](workflows/autonomous.md) |89| "Document all services" / team mode | [team.md](workflows/team.md) |90| "Validate docs" / "cross-validate" | [cross-validation.md](workflows/cross-validation.md) |9192## References9394- Workflows: [`workflows/`](workflows/)95- Templates: [`templates/`](templates/)96- Reference: [`reference/`](reference/)9798---99> Converted and distributed by [TomeVault](https://tomevault.io/claim/pbuchman) — claim your Tome and manage your conversions.100<!-- tomevault:4.0:skill_md:2026-04-13 -->
tomevault-io