document-writer

Generate technical documentation artifacts with Diátaxis classification and runnable examples.

7|1|Updated Mar 23, 2026
One-click install
npx skills add https://github.com/pranav8494/team-of-agents --skill document-writer-pranav8494
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-writer
Source: https://github.com/pranav8494/team-of-agents/tree/main/skills/document-writer
Command: npx skills add https://github.com/pranav8494/team-of-agents --skill document-writer-pranav8494

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It eliminates confusing, incomplete, or inconsistent documentation by producing clear, reader-focused technical content with runnable examples and correct structure.

Core Features & Use Cases

  • Documentation planning and safety checks: Announces intended changes, clarifies doc type, and asks before creating or overwriting files.
  • Diátaxis-consistent drafting: Ensures each output belongs to exactly one of Tutorial, How-to, Reference, or Explanation to prevent type-mixing confusion.
  • Task-specific outputs for common doc artifacts: Generates API references, READMEs, runbooks, ADRs, changelog entries, doc audits, and documentation-site IA.
  • Quality and style guardrails: Enforces runnable samples, consistent terminology, active voice, and consistent formatting (including templates).

Quick Start

Tell the skill to write a runbook for an alert named "Database latency spike" for SRE responders, including prerequisites, exact commands, expected outputs, and escalation.

Frequently Asked Questions about document-writer

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

FAQPage Schema
How do I write technical documentation using the Diátaxis framework?

Technical documentation using the Diátaxis framework is classified into exactly one of Tutorial, How-to, Reference, or Explanation types to prevent type-mixing confusion. This approach ensures each document serves a specific reader need, producing structured content for engineering and end-user consumption with runnable examples.

What is the best way to generate an API reference with runnable examples?

Generating an API reference with runnable examples requires following explicit templates and style rules that enforce active voice and consistent formatting. This approach produces high-quality technical documentation artifacts that include error cases and accurate, reader-focused content for engineering consumption.

How do I write a runbook for SRE incident response?

Writing a runbook for SRE incident response involves specifying prerequisites, exact commands, expected outputs, and escalation procedures for responders. This structured approach ensures the technical documentation artifact is accurate and actionable during alerts like a database latency spike.

Can I use this skill to generate Architecture Decision Records and changelogs?

Generating Architecture Decision Records and changelogs is supported as task-specific technical documentation outputs. The skill produces these artifacts using consistent terminology and explicit formatting templates, ensuring accurate recording of architectural decisions and software changes for engineering teams.

Does this documentation writer require confirmation before modifying existing files?

The documentation writer requires confirmation before creating or overwriting files as part of its documentation planning and safety checks. This mechanism announces intended changes, clarifies the doc type, and asks for user approval to prevent accidental data loss during artifact generation.

What is a documentation audit and how do I structure a documentation site?

A documentation audit evaluates existing content for consistency, accuracy, and completeness, while documentation-site structure involves organizing information architecture for optimal reader access. This skill enforces Diátaxis classification and style guardrails to produce a reader-focused site map.