technical-documentation

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

1|Updated Jun 9, 2026
One-click install
npx skills add https://github.com/JEROME-PRAKASH-L/openclaw --skill technical-documentation-jerome-prakash-l
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-documentation
Source: https://github.com/JEROME-PRAKASH-L/openclaw/tree/main/.agents/skills/technical-documentation
Command: npx skills add https://github.com/JEROME-PRAKASH-L/openclaw --skill technical-documentation-jerome-prakash-l

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Keeping technical documentation, AGENTS.md, and CONTRIBUTING.md files accurate, consistent, and aligned with actual repository behavior is difficult, especially across multiple docs frameworks and agent platforms. This Skill provides a structured build-and-review workflow that audits governance files and product docs together, detects drift, and applies fixes. ## Core Features & Use Cases - Docs Build & Review Playbooks: Classify tasks as build or review, brownfield or evergreen, and follow dedicated playbooks for structure, writing quality, and validation. - Governance & Agent-File Alignment: Inventory AGENTS.md, CONTRIBUTING.md, and alias files (CLAUDE.md, .cursorrules, .agents/), resolve precedence conflicts, and keep a single canonical policy core. - Framework & Path Validation: Verify Fern, Mintlify, and Sphinx configs, resolve config-relative paths, and detect stale routes or missing files. - Sub-Agent Orchestration: Delegate inventory, governance, framework, and synthesis work to bounded sub-agents for large repo-wide audits. - Use Case: Run a full-repo documentation audit that checks AGENTS/CONTRIBUTING consistency, validates docs framework configs, fixes broken references, and returns a prioritized fix plan with validation notes. ## Quick Start Use the technical-documentation skill to review this repository's docs and AGENTS.md files, fix any broken references or conflicting instructions, and report what was validated.

Frequently Asked Questions about technical-documentation

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

FAQPage Schema
How do I review technical documentation across an entire repository?

Use the review playbook to inventory governance files and product docs surfaces, then check structure, writing quality, framework configs, and cross-references. The workflow defaults to applying high-confidence fixes and returns blocking issues, improvements, and validation notes.

How do I keep AGENTS.md and CONTRIBUTING.md consistent?

Treat AGENTS.md as canonical when present, map alias files like CLAUDE.md and .cursorrules back to it, and run a conflict matrix review across all instruction files. Keep one shared policy core instead of duplicating guidance per agent platform.

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

Yes, the workflow detects framework configs first, resolves referenced paths relative to the declaring config, and validates both filesystem paths and published URL routes. It flags missing files, stale routes, and wrong base paths explicitly.

What is the difference between brownfield and evergreen documentation modes?

Brownfield mode prioritizes compatibility with existing docs IA, terminology, and tooling, preferring the smallest safe change set. Evergreen mode favors timeless wording, ownership signals, refresh triggers, and deprecation guidance for long-lived docs.

When should sub-agents be used for documentation audits?

Use sub-agents for large repos, multi-framework surfaces, or high-conflict governance work. Inventory, governance, and framework checks run in parallel, then a synthesis agent merges outputs into one prioritized, deduplicated fix plan.