loom-documentation

Solid

Creates and maintains technical documentation including API docs, READMEs, architecture docs, changelogs, ADRs, and inline code comments. Use for any documentation task from code-level docstrings to project-level guides.

Data & Documents 53 stars 0 forks Updated today MIT

Install

View on GitHub

Quality Score: 88/100

Stars 20%
58
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Documentation ## Overview Create and maintain documentation *artifacts* and their required structure: docstrings, inline comments, API references, READMEs, ADRs, changelogs, and architecture docs. This skill owns WHAT each artifact must contain. For prose mechanics (voice, clarity, sentence craft) and the Diátaxis mode framework, see `loom-technical-writing`. For visuals, see `loom-diagramming`; for API-spec files (OpenAPI), see `loom-api-documentation`. ## Artifact → structure map Pick the artifact by audience and Diátaxis mode, then fill its required structure. Never mix modes in one document (a reference is not a tutorial). | Artifact | Diátaxis mode | Must contain | | -------------------------- | ------------------ | --------------------------------------------------------------- | | README | how-to + reference | one-line pitch, install, quick-start, links out | | Tutorial / getting-started | tutorial | ordered steps, a path guaranteed to work, expected output | | How-to guide | how-to | goal-titled, prerequisites, numbered steps, verification | | API reference | reference | every public symbol: params, returns, errors, ≥1 example | | ADR | explanation | context, decision, consequences, alternatives, status | | Changelog | ...

Details

Author
cosmix
Repository
cosmix/loom
Created
8 months ago
Last Updated
today
Language
Rust
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category