doc-writer

Name: doc-writer
Availability: InStock
Author: crewrig

Write durable project documentation for READMEs, ADRs, and docstrings.

20|4|Updated May 14, 2026

Search Tags:#documentation #technical writing #adr #readme #reference #docstrings

Ready to run

npx skills add https://github.com/crewrig/crewrig --skill doc-writer-crewrig

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/crewrig/crewrig/tree/main/artifacts/core/skills/doc-writer
Command: npx skills add https://github.com/crewrig/crewrig --skill doc-writer-crewrig

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you create durable documentation for changing software, so readers get the right context, contracts, and decisions without wading through noise.

Core Features & Use Cases

README Writing: Produces clear project READMEs with the right section order for onboarding, usage, and reference.
ADR Authoring: Records architecture decisions with crisp context, decision, and consequence sections.
In-code Documentation: Writes module and function docstrings that describe contracts, side effects, and error modes.
Use Case: A public API changed and the docs no longer match; this Skill updates the documentation so integrators know the new contract and maintainers understand the rationale.

Quick Start

Ask the doc-writer skill to draft a README for this project using the current repository context.

Frequently Asked Questions about doc-writer

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

FAQPage Schema

How do I write durable technical documentation for a software project?▼

Durable technical documentation requires clear reader targeting, section-ordered structure, and contract-focused wording to prevent drift. This Skill creates long-lived guidance for READMEs, ADRs, and reference material that remains accurate as public contracts change.

What should be included in an architecture decision record?▼

An architecture decision record should include crisp context, decision, and consequence sections. This Skill records architecture decisions to help maintainers understand the rationale behind changes and ensure integrators know the new contract.

How do I write function docstrings that describe contracts and side effects?▼

Function docstrings should describe module and function contracts, side effects, and error modes. This Skill generates in-code documentation that provides concise, long-lived guidance for maintainers working with changing software.

What is the best way to structure a README for project onboarding and usage?▼

A README should follow the right section order for onboarding, usage, and reference. This Skill produces clear project READMEs that give readers the correct context, contracts, and decisions without wading through noise.

How to update documentation when a public API changes?▼

To update documentation when a public API changes, revise the material so integrators know the new contract and maintainers understand the rationale. This Skill updates project documentation to match changing public contracts and prevent drift.