skills.rest
DaoThiHuong2111
DaoThiHuong2111COMMUNITY
Explore all skills by this author →
GitHub

documentation

Generate semantic metadata for SKILL.md files to enable RAG integration.

Updated Oct 31, 2025
Search Tags:#templates#documentation#DRY#validation#structure#workflows#screens
One-click install
npx skills add https://github.com/DaoThiHuong2111/codeh-cli --skill documentation-daothihuong2111
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/DaoThiHuong2111/codeh-cli/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/DaoThiHuong2111/codeh-cli --skill documentation-daothihuong2111

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

Enforces documentation standards and structure for this project. This Skill helps enforce consistent documentation practices across screens, guides, and architecture, preventing duplicates and ensuring findings are searchable and DRY.

Core Features & Use Cases

  • Section-level tools: Enables efficient search, retrieval, and updates to specific sections without loading entire files.
  • Templates & workflows: Provides templates and workflows for screen docs, architectures, and guides to ensure a consistent structure.
  • DRY & structure enforcement: Prevents duplicates and organizes docs according to the project structure.

Quick Start

Start by scanning your docs for a topic with the doc-search tool, then use doc-get-section to retrieve a section, and doc-update-section to modify it. Follow the workflows in references/workflows/ and templates in assets/templates/ to create or update docs. For example, to add a new Home screen doc, create docs/screens/home/README.md using the screen templates, and validate with the rules in references/rules.md.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I standardize documentation structure across my project to reduce redundancy?▼

Standardizing documentation structure prevents duplicates and ensures consistency by enforcing templates and workflows. Use the provided screen, architecture, and guide templates in `assets/templates/`, follow the rules in `references/rules.md`, and organize docs according to your project structure. This approach enables searchable, DRY documentation that stays synchronized across sections.

Can I search and update specific sections of documentation without modifying entire files?▼

Yes, section-level tools enable efficient retrieval and updates to targeted documentation areas. Use doc-search to find topics, doc-get-section to retrieve specific sections, and doc-update-section to modify them independently. This capability reduces editing friction and minimizes the risk of unintended changes to surrounding content.

What's the best way to organize screen documentation to keep it consistent and maintainable?▼

Create screen docs following the template structure in `assets/templates/`, placing each in `docs/screens/{screen-name}/README.md`. The templates enforce consistent sections, metadata, and naming conventions. Validate your docs against the rules in `references/rules.md` to ensure they meet project standards and remain searchable.

How do I enforce documentation standards across my team's guides and architecture docs?▼

Documentation standards enforce consistency through templates, workflows, and validation rules. Define your standards in `references/rules.md`, provide team members with workflow examples from `references/workflows/`, and use templates in `assets/templates/` for common doc types. Section-level tools and search capabilities help maintain compliance as docs evolve.

Can I use these documentation workflows for different types of content like architectures and guides?▼

Yes, the Skill provides specialized templates and workflows for screens, architectures, and guides. Each has its own structure and metadata requirements defined in the templates and rules files. This multi-content approach ensures all documentation types follow the same standardization principles while respecting their unique purposes.

Why should I use semantic metadata and formal structure for my documentation instead of free-form text?▼

Semantic metadata enables accurate vector embedding and retrieval, making documentation searchable and accessible. Formal structure with declarative style and fixed formats ensures consistent RAG integration and allows automated validation of documentation quality. This approach transforms docs into a queryable knowledge base rather than static text.

Related Skills

Explore More Content & Communication Skills→
dgriffin831dgriffin831
3

text-processor

Normalize whitespace, strip HTML tags, and handle Markdown in raw text.

Community
Basic
christian-bromannchristian-bromann
3

langchain-knowledge-base

Build a searchable knowledge base from documents using LangChain.

Community
Advanced
anotbanotb

policy-diff

Compare two policy versions and generate a detailed change log.

Community
Advanced
aifuunaifuun

init-docs

Generate profile-aware documentation structures with ADRs, architecture, and deployment templates.

Community
Intermediate