docs

Validate and update canonical project documentation with init, update, check, and adr commands.

5|Updated May 2, 2026
One-click install
npx skills add https://github.com/vanducng/skills --skill docs-vanducng
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/vanducng/skills/tree/main/skills/docs
Command: npx skills add https://github.com/vanducng/skills --skill docs-vanducng

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Keep project docs honest, ensuring ./docs stay in sync with the codebase and decisions, and provide a repeatable workflow for ADRs and canonical docs.

Core Features & Use Cases

  • Validate and maintain the canonical docs set: README and docs/*-guidelines, system-architecture.md, tech-stack.md, and deployment.md.
  • Manage a documented ADR workflow under docs/decisions/ to capture architecture decisions and their rationale.
  • Provide a repeatable, auditable process for drift detection, updates, and adherence to contribution guidelines.

Quick Start

Invoke the vd docs workflow to initialize or update the repository's docs according to the canonical set.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I keep project documentation in sync with my codebase?

Maintain codebase documentation alignment by running validation checks against a canonical docs set to detect drift. This enforces an auditable workflow ensuring README, system-architecture, and tech-stack files stay current with code changes.

What is the best way to manage architecture decision records in a repository?

Manage ADRs by invoking a dedicated workflow that records architecture decisions and rationale under docs/decisions/. This provides a repeatable, auditable process for capturing technical choices and keeping decision records standardized.

How do I set up a standardized documentation workflow for my codebase?

Initialize a standardized documentation workflow by creating a canonical docs set including README, guidelines, system-architecture.md, tech-stack.md, and deployment.md. Use init, update, check, and adr commands to enforce repeatable documentation discipline.

Does this documentation validation workflow require any external dependencies?

This documentation validation workflow operates with zero external dependencies. It applies lightweight, auditable documentation discipline directly to your codebase, enforcing required files, freshness, and reference checks without needing additional packages.

When should I run documentation drift detection checks?

Run documentation drift detection checks whenever code changes impact the canonical docs set. Regular validation ensures required files, references, and ADR records under docs/decisions/ remain accurate, fresh, and synchronized with the current codebase state.