A collection of agent skills for drafting, reviewing, and improving software documentation, aligned with the Agent Skills open specification.
| Skill | Description |
|---|---|
| software-design-doc | Draft, review, update, and drift-check Software Design Descriptions (SDD) with an IEEE 1016-2009-inspired pragmatic structure.† |
† See Standards and Copyright Notice.
- This repository provides independently authored templates, checklists, and workflows informed by IEEE 1016-2009 concepts.
- It does not include IEEE standard text, figures, or tables, and it is not a substitute for the official standard.
- This repository is unofficial guidance.
- IEEE standards are copyrighted by IEEE; use a properly licensed copy when you need normative wording.
- "IEEE" and related marks are trademarks of IEEE.
- Official IEEE standard page: IEEE Std 1016-2009.
- See NOTICE for the third-party standards notice included in this repository.
To install all skills, use the following command:
- Install with skills CLI (recommended):
npx skills add https://github.com/RJTPP/agent-software-doc-skills --skill '*'- Install with OpenAI Codex via
$skill-installerskill:
$skill-installer install all skills from RJTPP/agent-software-doc-skillsTo install a specific skill, replace the <SKILL_NAME> in the following command with the name of the skill you want to install:
- For Skills CLI:
npx skills add https://github.com/RJTPP/agent-software-doc-skills --skill <SKILL_NAME>- For OpenAI Codex:
$skill-installer install <SKILL_NAME> from RJTPP/agent-software-doc-skillsnpx skills add https://github.com/RJTPP/agent-software-doc-skills --skill software-design-docThe items below are exploratory roadmap candidates and may change in the future.
| Skill | Description | Reference |
|---|---|---|
| product-requirements-doc | Elicit business goals from the user and produce a structured Product Requirements Document (PRD). | Industry practice (no formal IEEE standard) |
| software-requirements-doc | Draft and review Software Requirements Specifications (SRS/SRD) with an IEEE 29148-2018-inspired structure. | IEEE 29148-2018 |
| architecture-decision-record | Capture, review, and update Architecture Decision Records (ADR) for major design changes, tradeoff decisions, technology adoptions/deprecations, and other decisions that need explicit rationale and alternatives. | ADR practice / architecture decision records |
| readme-creator | Create/update README.md from repository context, with optional related repository documentation consistency updates. | Repository documentation best practices |
| docs-composer | Compose the full documentation suite by coordinating the available skills together end-to-end. | — |
| docs-openspec-sync | Bridge formal docs and OpenSpec tasks — convert SDD/SRD into OpenSpec change artifacts, or sync OpenSpec tasks back to docs. Detects if OpenSpec is installed and guides installation if not. | OpenSpec |
PRD → SRD → SDD ─────────────► (implementation) → README.md
│ ▲
├──► ADR ────────────────┤
└──► OpenSpec tasks ─────┘
(via docs-openspec-sync)
Each skill would handle one layer of the pipeline, from high-level business requirements through to a deployable, documented project.