skills.rest
Lawrence908
Lawrence908COMMUNITY
Explore all skills by this author →
GitHub

technical-documentation

Create structured technical documentation including READMEs, API references, guides, and runbooks.

Updated Sep 14, 2026
Search Tags:#documentation#markdown#technical writing#readme#guides#api documentation#runbooks
One-click install
npx skills add https://github.com/Lawrence908/chiron --skill technical-documentation-lawrence908
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-documentation
Source: https://github.com/Lawrence908/chiron/tree/main/plugins/writing/skills/technical-documentation
Command: npx skills add https://github.com/Lawrence908/chiron --skill technical-documentation-lawrence908

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing clear, complete technical documentation is time-consuming and often results in outdated examples, missing setup steps, or inconsistent formatting that confuses readers. ## Core Features & Use Cases - Structured Document Generation: Produces READMEs, installation guides, API references, troubleshooting runbooks, and architecture docs with clear sections and tables of contents. - Working Code Examples: Includes real, runnable code snippets for setup, authentication, and API usage rather than pseudocode. - Audience-Targeted Writing: Adjusts technical depth and language for developers, users, or operators. - Use Case: Given a FastAPI task management project, generate a complete README with features, prerequisites, setup steps, curl usage examples, and a troubleshooting section. ## Quick Start Ask the assistant to create a README for your project, specifying the tech stack, target audience, and any setup or API details to include.

Frequently Asked Questions about technical-documentation

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

FAQPage Schema
How do I write a good README for a software project?▼

A good README includes a project overview, feature list, prerequisites, step-by-step installation instructions, usage examples with working code, and troubleshooting guidance. Structure it with clear sections and a table of contents for longer documents.

How to document REST API endpoints with examples?▼

Document each endpoint with its HTTP method, path, authentication requirements, request parameters, and a working curl example showing real requests and responses. Group endpoints logically and link to a full API reference for complete details.

What should a troubleshooting guide include?▼

A troubleshooting guide should list common errors, their root causes, and concrete diagnostic commands or fixes. Cover edge cases like connection failures and configuration mismatches, and explain why each step is necessary.

When should I not write exhaustive documentation?▼

Avoid exhaustive docs for rapidly changing prototypes or internal throwaway scripts where maintenance cost exceeds value. Focus on a minimal README with setup and usage, and expand only when the project stabilizes or gains external users.

Related Skills

Explore More Content & Communication Skills→
githubgithub
5.1k

reflect

Extracts confidence-rated learning patterns from conversations to update agent history and team decisions.

Official
Intermediate
lailtonjuniorlailtonjunior

Documentation

Generate and update Markdown and HTML documentation from code, schemas, and design notes.

Community
Intermediate
NimbleBrainIncNimbleBrainInc
2

docs-auditor

Audit documentation against the codebase and generate a structured health report.

Official
Advanced
ChenYCLChenYCL

api-docs

Generate API documentation and OpenAPI 3.0 specs from code or descriptions.

Community
Intermediate