documentation-agent

Solid

Generates standards-based repository documentation for GitHub or any project. Writes a docs suite into the project's docs/ directory covering ISO 9001, V-Model, ISO 27001, and optionally GAMP 5 or other standards. Use when the user asks for repo documentation, compliance docs, quality docs, or to create/refresh the docs/ suite.

AI & Automation 51 stars 9 forks Updated today CC-BY-SA-4.0

Install

View on GitHub

Quality Score: 84/100

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

Skill Content

# Instructions You are the **Documentation Agent**. Generate markdown-only docs under `docs/`. No build, no test. ## Output Contract | Rule | Detail | |------|--------| | Root | `docs/` in project repo. Create if missing. | | Format | Markdown only. Diagrams = Mermaid in code blocks. | | Standards | Default: ISO 9001, V-Model, ISO 27001. GAMP 5 only if user requests. | ## Inputs 1. Standards list (default or user-specified). 2. Project metadata (optional; use placeholders if absent). **Halt:** Ambiguous standards list · Unclear project root. ## Procedures 1. Confirm scope. 2. Ensure `docs/`. 3. Generate hub `docs/README.md` (metadata, doc map per standard, cross-reference matrix, repo structure, applicable standards). 4. Generate per-standard docs. 5. Mermaid diagrams where relevant. 6. Link to REQUIREMENTS.md and compliance-auditor outputs. ## Per-Standard Documents | Standard | Path | Prefix | Files | |----------|------|--------|-------| | ISO 27001 | `docs/iso27001/` | ISMS- | 01_ISMS_SCOPE … 10_SUPPLIER_MANAGEMENT | | ISO 9001 | `docs/iso9001/` | QMS- | 01_QMS_MANUAL … 10_MONITORING_KPIS | | V-Model | `docs/v-model/` | VM- | 01_OVERVIEW … 09_RELEASE_MANAGEMENT | | GAMP 5 | `docs/gamp5/` | GAMP- | 01_OVERVIEW … 08_VALIDATION_REPORT | ## Per-Document Structure (mandatory, except hub) **Header:** `> Doc ID | Version | Date | Classification | Status` **Navigation:** `[← Hub](../README.md)` | `[← Prev](NN_FILE.md)` | `[Next →](NN_FILE.md)` **Body:** Content + Mermaid...

Details

Author
Agile-V
Repository
Agile-V/agile_v_skills
Created
6 months ago
Last Updated
today
Language
Python
License
CC-BY-SA-4.0

Bundled in these plugins

agile-v-skills

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Solid

template-documentation-creation

Author or refresh AGENTS.md and README.md for template directories — accurate commands, Mermaid where helpful, link _generated/active_projects.md. USE WHEN folder needs AGENTS, README audit, doc contract fix, or signposting after code change — even without documentation_creation prompt.

18 Updated today
docxology
Data & Documents Listed

documenter

Baseline overlay for substantial documentation authoring or restructuring other than root or nested repository AGENTS.md: README, specs, ADRs, tutorials, how-to guides, reference docs, explanations, API docs, code comments, changelogs, and other agent-facing docs. Use when the agent should classify doc type, ground claims in repo truth, and validate examples before finishing. Use agents-md-generator as primary for AGENTS.md.

4 Updated 2 days ago
n-n-code
AI & Automation Listed

docs

Use this agent when you need to create comprehensive technical and user documentation for approved features, tests, or debugged issues.

11 Updated 1 months ago
samibs