skills.rest
gajakannan
gajakannanCOMMUNITY
Explore all skills by this author →
GitHub

technical-writer

Generate API references, runbooks, and guides from code and planning artifacts.

6|Updated Jan 25, 2026
Search Tags:#documentation#APIs#frontmatter#runbooks#developer guides#audience-focused
One-click install
npx skills add https://github.com/gajakannan/nebula-crm --skill technical-writer-gajakannan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/gajakannan/nebula-crm/tree/main/agents/technical-writer
Command: npx skills add https://github.com/gajakannan/nebula-crm --skill technical-writer-gajakannan

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures accurate, audience-specific documentation is produced from implemented behavior for APIs, runbooks, and developer guides, reducing ambiguity and drift.

Core Features & Use Cases

  • Generate API references, runbooks, architecture guides, and onboarding content from code and planning artifacts.
  • Enforce frontmatter metadata usage and structured sections to ensure consistency across docs.
  • Provide audience-focused, task-oriented guidance that aligns with project decisions and implementation details.

Quick Start

Start by collecting implemented behavior details and planning artifacts, then invoke the Technical Writer to generate up-to-date documentation for APIs, runbooks, and developer guides.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I generate API references and developer guides from implemented code?▼

You can generate API references and developer guides by collecting implemented behavior details and planning artifacts, then invoking an automated documentation process. This extracts frontmatter metadata and structured sections directly from code to produce audience-focused, verifiable documentation.

What is the best way to keep runbooks and architecture guides consistent with code changes?▼

Keeping runbooks and architecture guides consistent requires automating documentation generation during ongoing maintenance. Enforcing frontmatter-driven metadata extraction and structured multi-section descriptions ensures your runbooks remain verifiable and aligned with actual implemented behavior.

How does frontmatter metadata extraction work for API documentation?▼

Frontmatter metadata extraction for API documentation works by pulling structured metadata like name and description directly from code and planning artifacts. This metadata drives the generation of structured, multi-section descriptions, ensuring consistency and verifiability across all generated API references and developer guides.

Can I create audience-focused onboarding content from existing planning artifacts?▼

Yes, you can create audience-focused onboarding content from existing planning artifacts. By cross-referencing implementation details with project decisions, the documentation process generates task-oriented guidance tailored to specific audiences, ensuring new developers receive relevant and accurate onboarding material.

When do I need to automate documentation generation for APIs and runbooks?▼

You need to automate documentation generation for APIs and runbooks during Phase C implementation and ongoing maintenance. This prevents ambiguity and drift between code and documentation, ensuring that API references, runbooks, and architecture guides remain accurate and verifiable as implemented behavior evolves.

Related Skills

Explore More Content & Communication Skills→
s0613s0613
1

docs-organize

Generate standardized project documentation and 0-100 health scores from codebases.

Community
Advanced
rikdcrikdc
2

document

Generate technical documentation from OpenAPI specs and code annotations.

Community
Intermediate
KahtafKahtaf
9

source-command-opsx-propose

Automate change proposals and generate proposal.md, design.md, and tasks.md artifacts.

Community
Intermediate
PP-NamiasPP-Namias
2

technical-writing

Generate technical documentation and README files from predefined templates.

Community
Intermediate