tech-docs-skill

Generates API references, runbooks, ADRs, onboarding guides, and READMEs from code context.

Updated Aug 12, 2026
One-click install
npx skills add https://github.com/innFactory-AI/company-ai-stack-skills --skill tech-docs-skill-innfactory-ai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: tech-docs-skill
Source: https://github.com/innFactory-AI/company-ai-stack-skills/tree/main/de/skills/engineering/tech-docs-skill
Command: npx skills add https://github.com/innFactory-AI/company-ai-stack-skills --skill tech-docs-skill-innfactory-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing and maintaining technical documentation is time-consuming, and outdated or invented docs mislead teams. This Skill turns code context, informal descriptions, or existing system knowledge into structured, maintainable technical documentation with the right template for each audience. ## Core Features & Use Cases - Document Type Router: Routes your request to the right template — API reference, runbook, ADR, onboarding guide, or README — based on audience and purpose. - Ready-Made Templates: Provides complete, fill-in structures for each document type, including endpoint tables, step-by-step runbook procedures, and ADR decision records. - Honesty Guardrails: Never invents endpoints, parameters, or architecture; marks gaps explicitly with placeholders like [NOCH AUSZUFÜLLEN] so docs stay trustworthy. - Use Case: A developer finishing a new REST API asks for documentation and receives a complete API reference with authentication, endpoint tables, request/response examples, and error codes — with unverifiable details clearly flagged instead of fabricated. ## Quick Start Ask the agent to write documentation for your API, system, or architecture decision and provide the relevant code or context.

Frequently Asked Questions about tech-docs-skill

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

FAQPage Schema
How do I write API documentation from existing code?▼

Provide the source code or a description of your API, and the Skill generates a complete API reference template covering authentication, endpoints, request/response tables, error codes, rate limits, and versioning. Missing details are marked with placeholders rather than invented.

How to create an architecture decision record (ADR)?▼

Describe the technical decision and its context, and the Skill produces an ADR with status, date, context, the decision statement, considered options with pros and cons, consequences, and concrete review triggers.

What types of technical documentation can this generate?▼

It supports five document types: API references, operational runbooks, architecture decision records, onboarding guides, and project READMEs. A router selects the right template based on your audience and purpose.

Can it write a runbook for on-call incident procedures?▼

Yes. The runbook template includes purpose, prerequisites, severity, step-by-step commands with expected output and failure handling, verification, rollback, escalation contacts, and a change history table.

Does the documentation skill work without connected data sources?▼

Yes. While it can pull context from companyRAG collections or Git providers via MCP, you can also paste information directly in chat or upload files. Unverifiable details are flagged as gaps instead of being fabricated.

What are the limitations of AI-generated technical documentation?▼

The Skill cannot verify technical accuracy against a live system, so code examples and API details must be validated by engineers. It deliberately leaves placeholders for missing information rather than guessing, which requires manual completion.