technical-documentation

Build and review technical documentation and agent instruction files across repository docs surfaces.

Updated Jun 19, 2026
One-click install
npx skills add https://github.com/AmirulAndalib/Vilvona-AI --skill technical-documentation-amirulandalib
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-documentation
Source: https://github.com/AmirulAndalib/Vilvona-AI/tree/main/.agents/skills/technical-documentation
Command: npx skills add https://github.com/AmirulAndalib/Vilvona-AI --skill technical-documentation-amirulandalib

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Keeping technical documentation, AGENTS.md, and CONTRIBUTING.md accurate and consistent across a repository is difficult, especially when docs span multiple frameworks, locales, and agent instruction aliases that drift out of sync. ## Core Features & Use Cases - Build and review playbooks: Classify work as build or review, brownfield or evergreen, then follow structured playbooks covering structure, writing quality, and validation. - Governance and alias management: Inventory AGENTS.md, CONTRIBUTING.md, and alias files like CLAUDE.md or .cursorrules, resolve precedence conflicts, and keep one canonical policy core. - Framework-aware path validation: Verify Fern, Mintlify, and Sphinx configs so referenced files exist and URL routes match source paths. - Use Case: Run a full-repo documentation audit that maps every docs surface, detects broken commands and missing referenced files, applies high-confidence fixes, and returns a prioritized issue report with validation notes. ## Quick Start Ask the agent to review this repository's documentation and AGENTS.md for broken references, conflicting instructions, and structural issues, then apply the safe fixes.

Frequently Asked Questions about technical-documentation

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

FAQPage Schema
How do I review repository documentation for broken links and stale commands?

Run a documentation review that inventories README files, docs directories, and framework configs, then validates referenced paths, commands, and anchors. High-confidence defects like missing files or non-existent setup commands are fixed in the same pass unless report-only mode is requested.

How to keep AGENTS.md and CONTRIBUTING.md consistent across a repo?

Treat AGENTS.md as the canonical instruction source, map alias files like CLAUDE.md and .cursorrules back to it, and run a conflict matrix review across governance files. Align commands, boundaries, and PR workflow guidance with actual repository practices.

Does this work with docs frameworks like Fern, Mintlify, or Sphinx?

Yes, the workflow detects framework configuration files first and resolves referenced paths relative to the declaring config. It validates both that configured files exist on disk and that navigation routes map to consistent URL paths.

What is the difference between brownfield and evergreen documentation modes?

Brownfield mode prioritizes compatibility with existing docs architecture, terminology, and navigation, favoring the smallest safe change set. Evergreen mode favors timeless wording, ownership signals, refresh triggers, and deprecation guidance so docs stay accurate over time.

When should sub-agents be used for documentation audits?

Sub-agents are recommended for large repositories, multi-framework docs, or high-conflict governance work. Inventory, governance, and framework checks run in parallel, then a synthesis step merges findings into one prioritized, deduplicated fix plan.