doc-writer

Generate ADRs, READMEs, and docstrings aligned with code changes.

3|Updated Mar 16, 2026
One-click install
npx skills add https://github.com/hcross/crewrig --skill doc-writer-hcross
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/hcross/crewrig/tree/main/.gemini/skills/doc-writer
Command: npx skills add https://github.com/hcross/crewrig --skill doc-writer-hcross

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation debt slows teams when ADRs, READMEs, and in-code docstrings lag behind code changes. This skill helps produce clear, durable references that age well.

Core Features & Use Cases

  • Automatic ADR and README draft templates aligned with code changes.
  • In-code docstring standardization and cross-linking to references.
  • Quick reference generation for architecture decisions and contracts.

Quick Start

Generate an ADR and README draft for a new module with cross-linked references and code exemplars.

Frequently Asked Questions about doc-writer

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

FAQPage Schema
How do I generate an ADR and README draft for a new software module?

To generate an ADR and README draft, apply structured templates aligned with code changes, cross-linking references to sources, and including code exemplars. This produces durable onboarding materials and architecture decisions consistent with module contracts.

What is the best way to keep in-code docstrings aligned with code changes?

Keeping in-code docstrings aligned requires standardizing docstring formats and cross-linking them to reference documentation. Structured templates enforce consistency, preventing documentation debt from accumulating as the codebase evolves.

When do I need to write an Architecture Decision Record?

You need to write an Architecture Decision Record when making significant structural choices that require enduring reference documentation. ADRs capture the context and contracts behind decisions, ensuring future teams understand the rationale as modules change.

Can I standardize existing reference documentation across multiple modules?

You can standardize existing reference documentation across modules by applying structured templates and cross-linking sources. This process updates aging materials into consistent references that align with current code contracts and architecture decisions.

Does this approach work for generating quick reference guides for software contracts?

This approach works for generating quick reference guides for software contracts by extracting architecture decisions and module information into structured, cross-linked documentation that stays current with code modifications.