docs

Generates standards-based enterprise documentation wikis with full authoring and incremental sync modes.

Updated Jul 28, 2026
One-click install
npx skills add https://github.com/truongnat/Restly --skill docs-truongnat
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/truongnat/Restly/tree/main/.agents/skills/docs
Command: npx skills add https://github.com/truongnat/Restly --skill docs-truongnat

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping project documentation accurate and complete is hard: wikis drift out of sync with code, requirements lack traceability, and architecture decisions get lost. This Skill authors and maintains a full enterprise documentation set (SRS, Architecture, HLD, LLD, ADRs, Reference, Operations, Guides) grounded in recognized standards, with every claim cited to a source and gaps marked explicitly instead of invented. ## Core Features & Use Cases - Full documentation authoring: Builds the complete doc tree document-by-document following ISO/IEC/IEEE 29148 (SRS), arc42 + C4 + 4+1 (Architecture), IEEE 1016 (HLD/LLD), ADR (MADR/Nygard), and Diátaxis (Guides), with stable IDs (FR/NFR/ADR/BR) and a traceability thread from requirement to code. - Incremental sync mode: Uses a .docmap.md manifest mapping wiki units to source paths, so a git diff determines exactly which documents and sections to refresh after a code change. - Multiple output formats: Markdown is the canonical source; the same content renders to self-contained HTML, a single controlled DOCX (via the docx skill), or an XLSX workbook of registers and matrices (via the xlsx skill). - Use Case: After merging a feature branch that adds a new API endpoint, run sync mode to update only the API reference, LLD interface contracts, and coverage matrix rows affected by the change, leaving the rest of the wiki untouched. ## Quick Start Ask the agent to run the docs skill in full mode to author the entire documentation set, or in sync mode to update only the documents affected by your latest code changes.

Frequently Asked Questions about docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate an SRS and architecture documentation from my codebase?▼

Run the docs skill in full mode. It authors each document to its standard (ISO/IEC/IEEE 29148 for SRS, arc42 with C4 diagrams for architecture), reusing session artifacts like BUSINESS_ANALYSIS.md and BASIC_DESIGN.md, and cites code paths as sources for every claim.

How do I keep project documentation in sync after code changes?▼

Use sync mode. The skill reads the .docmap.md manifest mapping wiki units to source paths, diffs against the last-synced commit, and updates only the affected documents and sections plus the coverage matrix.

What documentation standards does this skill follow?▼

SRS follows ISO/IEC/IEEE 29148, architecture follows arc42 with C4 and 4+1 views, decisions use ADR (MADR/Nygard), HLD and LLD follow IEEE 1016-2009 design viewpoints, and user guides follow the Diátaxis framework.

Can the documentation be exported to Word or Excel formats?▼

Yes. Markdown is the canonical source, and the skill renders the same content to self-contained HTML, a single DOCX with heading styles and TOC via the docx skill, or an XLSX workbook of requirement registers and traceability matrices via the xlsx skill.

What happens when evidence for a requirement or decision is missing?▼

The skill never invents content. Missing evidence is marked as Gap or Unknown, added to the coverage matrix in Home.md, and sections that do not apply are marked N/A with a one-line reason rather than deleted.

Does the docs skill modify project source code?▼

No. It is read-only against project code except for running the bundled workspace scanner script. It writes only to the configured wiki location and honors a branch gate that can restrict writes to the main branch.