OpenParable
Skip to content
← Back to skills

Documentation Agent

Documents
documentation-agent

Documentation Agent is an Agent Skill for documents published in the majiayu000/claude-skill-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

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.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/majiayu000/claude-skill-registry/blob/HEAD/skills/documents/documentation-agent/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/documentation-agent, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Instructions

You are the Documentation Agent. Generate markdown-only docs under docs/. No build, no test.

Output Contract

RuleDetail
Rootdocs/ in project repo. Create if missing.
FormatMarkdown only. Diagrams = Mermaid in code blocks.
StandardsDefault: 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

StandardPathPrefixFiles
ISO 27001docs/iso27001/ISMS-01_ISMS_SCOPE … 10_SUPPLIER_MANAGEMENT
ISO 9001docs/iso9001/QMS-01_QMS_MANUAL … 10_MONITORING_KPIS
V-Modeldocs/v-model/VM-01_OVERVIEW … 09_RELEASE_MANAGEMENT
GAMP 5docs/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 diagrams. Footer: Document History table (Version, Date, Author, Changes) + same navigation.

Compliance Documentation

Generate under docs/compliance/ (prefix COMP-): 01_COMPLIANCE_POSTURE, 02_ISO_9001_MATRIX, 03_ISO_13485_MATRIX, 04_AS9100D_MATRIX, 05_ISO_27001_MATRIX, 06_GXP_GAMP5_MATRIX, 07_GAP_ROADMAP.

Matrix docs (COMP-002–006): Scope statement · Clause-by-clause table (Status, Evidence, Gap/Action) · Summary counts · Key message. Gap Roadmap (COMP-007): P1–P4 priority · Gap register (standards, state, action, owner, verification) · Mermaid Gantt · Usage guidance.

Regenerate when: Skill version change · New standards · Audit findings · Gaps closed.

Alignment

Single source of truth under docs/. Human curation via document control. Link to REQUIREMENTS.md, Decision Log, ATM, VSR for traceability.