writing-documents

Community

Craft clear, impactful documents.

Authorgavinmcfall
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill addresses the challenge of creating high-quality documentation by providing structured guidance and best practices for different document types, ensuring clarity, accuracy, and preventing the spread of misinformation.

Core Features & Use Cases

  • Document Type Guidance: Offers specific advice for creating north-star, gestalt, reference, research, design, plan, flow, findings, concepts, and process documents.
  • Quality Assurance: Implements hard rules and checklists to ensure information is verifiable, accurate, and well-structured.
  • Use Case: When tasked with writing a design document for a new feature, this Skill guides you through defining the architecture, identifying trade-offs, and ensuring all necessary aspects are considered before implementation.

Quick Start

Use the writing-documents skill to generate a plan for documenting a new API endpoint.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: writing-documents
Download link: https://github.com/gavinmcfall/agentic-config/archive/main.zip#writing-documents

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.