skills.rest
Conradmaker
ConradmakerCOMMUNITY
Explore all skills by this author →
GitHub

writing-document

Structure and write technical documentation using standardized templates.

Updated Apr 27, 2026
Search Tags:#changelog#templates#documentation#troubleshooting#adr#reference#api-reference
One-click install
npx skills add https://github.com/Conradmaker/copilot-cockpit --skill writing-document
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-document
Source: https://github.com/Conradmaker/copilot-cockpit/tree/main/.github/skills/writing-document
Command: npx skills add https://github.com/Conradmaker/copilot-cockpit --skill writing-document

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Technical documentation is often inconsistent and hard to maintain across changelogs, API references, guides, ADRs, and troubleshooting. This skill provides a structured, principle-driven approach to design and write developer docs at scale.

Core Features & Use Cases

  • Documentation pattern templates for changelogs, API references, ADRs, guides, and troubleshooting.
  • Principles-driven workflow: audience definition, structure-first design, code-first examples, versioning and self-review gates.
  • Template-driven authoring with references for consistent guidance and reuse across teams.

Quick Start

Follow the templates and principles to draft consistent, publish-ready documentation.

Frequently Asked Questions about writing-document

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

FAQPage Schema
How do I write consistent API references and changelogs for developer documentation?▼

Write API references and changelogs using standardized templates with audience-focused planning, structure-first design, and self-review gates to ensure consistency and publish-ready outputs.

What is the best way to structure architecture decision records for technical docs?▼

Structure ADRs using template-driven formats that apply principles of audience definition, code-first examples, and versioning to ensure clear, maintainable architecture decision records.

Can I use a single workflow for guides, troubleshooting, and API references?▼

Yes, a principles-driven documentation workflow applies template-driven authoring and self-review gates to unify guides, troubleshooting, API references, and changelogs for consistent reuse.

How do you maintain versioning and consistency across technical documentation at scale?▼

Maintain documentation versioning and consistency by applying standardized templates, audience-focused planning, and self-review gates designed for scalable developer docs across teams.

When do I need template-driven authoring for product documentation?▼

You need template-driven authoring when writing high-quality product documentation that requires standardized formats for changelogs, ADRs, and references to ensure maintainability and consistency.

Does template-driven documentation support integration with SKILL.md frontmatter?▼

Yes, template-driven documentation outputs are ready for publishing or direct integration into SKILL.md frontmatter, providing structured guidance for future updates and versioning.

Related Skills

Explore More Content & Communication Skills→
hffmnnjhffmnnj
39

technical-writing

Creates structured technical documentation with templates, checklists, and best practices.

Community
Basic
buiphucminhtambuiphucminhtam
47

technical-writer

Generate developer-facing documentation from codebase artifacts.

Community
Advanced
danieldev24danieldev24

ci-cd-and-automation

Automates CI/CD pipeline setup and quality gates for code verification.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced