documentation

Generate ADRs, runbooks, and README files in markdown, mdx, and github-flavored-markdown.

Updated Mar 5, 2026
One-click install
npx skills add https://github.com/JFrangel/AI-Agents-Skills --skill documentation-jfrangel
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/JFrangel/AI-Agents-Skills/tree/main/public/skills/documentation/documentation
Command: npx skills add https://github.com/JFrangel/AI-Agents-Skills --skill documentation-jfrangel

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill streamlines the creation and organization of technical documentation, ensuring clarity, consistency, and discoverability for developers, AI agents, and stakeholders.

Core Features & Use Cases

  • Automated Documentation Generation: Drafts Architecture Decision Records (ADRs), runbooks, and README files.
  • Context Engineering: Organizes documentation within a structured docs/ directory, preventing "orphan" knowledge.
  • Use Case: When introducing a new feature, use this Skill to generate an ADR explaining the decision-making process, a runbook for developers on how to use it, and update the project's README.

Quick Start

Use the documentation skill to draft an ADR for the new authentication module.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate an Architecture Decision Record for a new software feature?

To generate an Architecture Decision Record (ADR), use this Skill to draft the document explaining your decision-making process while adhering to corporate technical writing standards. It automatically structures the ADR within your project's `docs/` directory to ensure discoverability and proper linking.

What's the best way to structure technical documentation to prevent orphan knowledge?

The best way to prevent orphan knowledge is by applying context engineering principles to organize files within a structured `docs/` directory. This approach ensures all README files and runbooks are well-linked, discoverable, and consistently formatted for developers and AI agents.

Can I create runbooks and README files in github-flavored-markdown?

Yes, you can create runbooks and README files using github-flavored-markdown, standard markdown, or mdx formats. The Skill generates and manages this technical documentation while enforcing corporate writing standards and context engineering guidelines.

Does context engineering require a specific directory structure for technical documentation?

Context engineering requires placing technical documentation within a structured `docs/` directory to maintain discoverability. This setup ensures that generated ADRs, runbooks, and README files are properly linked rather than isolated, preventing orphan knowledge across the project.

How do I update a project README when introducing a new authentication module?

To update a project README for a new authentication module, use this Skill to draft the changes alongside generating a corresponding runbook and ADR. It structures the updates within the `docs/` directory to maintain clear, consistent technical writing standards.

When do I need to create an ADR instead of a standard README file?

You need to create an Architecture Decision Record (ADR) when you must document the decision-making process behind a specific architectural choice, rather than using a README file which explains how to use the project. The Skill drafts both formats using context engineering to keep them linked.