Skip to main content

documentation-agent

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.

Zur Installation springen

Quellinformationen

Repository
Agile-V/agile_v_skills
Letzte Quellaktivität
25. August 2026 um 07:17
Erkannte Sprache von SKILL.md
Englisch
Sterne
54
Forks
10

Installationsoptionen

Standardmäßig ist der Prompt ausgewählt, der zuerst die Quelle prüft. Sie können zu einem direkten Befehl wechseln oder eine lokale Kopie herunterladen.

Quelldateien prüfen

Lesen Sie SKILL.md und alle von SkillsMP angezeigten Begleitdateien, bevor Sie sich für eine Installation entscheiden.

SKILL.md wird angezeigt

SKILL.md
Quellanweisungen · Schreibgeschützte Vorschau
name
documentation-agent
description
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.
license
CC-BY-SA-4.0
metadata
{"version":"1.4","standard":"Agile V","author":"agile-v.org","sections_index":["Output Contract","Procedures","Per-Document Structure","Compliance Documentation","Qualification Documentation Duties"]}
# 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 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. ## Control Matrix Documentation When `.agile-v/CONTROL_MATRIX.yaml` or `config/control_matrix.yaml` exists, generate `docs/control-matrix.md`: - **Control summary table:** `id | status | scope | minimum_risk_level | description` - **Owner table:** `id | business_owner | technical_owner | security_owner | reviewer` - **Human Gate table:** `id | action | gate | approver_role` - **Tool allowlist and denylist:** per control entry - **Rollback and cost summary:** strategy, max time, run/daily limits, currency - **Review cycle and status:** `last_reviewed | review_cycle_days | reviewer_role` Generated docs must not expose secrets. If a log location or owner field is marked sensitive in the matrix, redact according to the matrix's `redact_personal_data` setting. ## AI-BOM Documentation Rules When generating project documentation: - Document the project's AI-BOM policy (high-level) in `docs/` if `templates/AI_BOM_POLICY.yaml` is in use. - Keep public docs high-level; keep evidence manifests in controlled release evidence directories (`.agile-v/aibom/`). - Do not publish sensitive model endpoints, API keys, secrets, internal prompts, or proprietary policy details without explicit review and redaction. - Reference `docs/ai-influence-traceability.md` for AI provenance guidance when generating compliance or governance docs. ## Qualification Documentation Duties When the project's local quality profile establishes that qualification applies (see `agile-v-gxp-qualification`; DQ/IQ/OQ/PQ are **evidence stages**, not agent names): - **Maintain qualification documentation.** Keep qualification plans, protocols, stage records (DQ/IQ/OQ/PQ), summary/qualification reports, and their cross-references current under `docs/` (e.g. `docs/gamp5/` and `docs/compliance/`), linking to the controlled evidence bundle rather than duplicating it. - **Keep source status current.** Reflect the actual state of each document and stage (draft, in-review, approved, superseded, conditional, waived) and update it when qualification state changes; do not present stale or aspirational status as current. - **Use non-certification language.** Describe qualification status, coverage, and gaps. Do not state or imply certification, conformity assessment, regulatory approval, or release authority — those are separate human/quality-authority decisions recorded elsewhere. ## Alignment Single source of truth under `docs/`. Human curation via document control. Link to REQUIREMENTS.md, Decision Log, ATM, VSR, CONTROL_MATRIX.yaml, and AI_RUN_MANIFEST (via evidence fragment) for traceability.
Auf GitHub ansehen