technical-documentation-drafter

Draft developer documentation with a six-section docs/ structure.

Updated May 12, 2026
One-click install
npx skills add https://github.com/RorySullivan1/claudeBrain --skill technical-documentation-drafter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-documentation-drafter
Source: https://github.com/RorySullivan1/claudeBrain/tree/main/example-project/.claude/skills/technical-documentation-drafter
Command: npx skills add https://github.com/RorySullivan1/claudeBrain --skill technical-documentation-drafter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Produces coherent, developer-focused documentation for codebases, aligning teams on architecture, setup, conventions, contribution workflows, references, and release procedures.

Core Features & Use Cases

  • Structured docs: Generates a complete docs/ folder with an index and six core sections for consistent contributor guidance.
  • Project-scoped guidance: Tailors architecture, setup, conventions, contributing, and reference materials to the target codebase.
  • Onboarding acceleration: Helps new engineers understand how to contribute and how the project is organized.
  • Use Case: Given a new library, create developer docs that explain how to build, test, contribute, and release.

Quick Start

Create a docs/ package with the six sections and an index.md linking to architecture.md, setup.md, conventions.md, contributing.md, reference.md, and releases.md.

Frequently Asked Questions about technical-documentation-drafter

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

FAQPage Schema
How do I create structured developer documentation for a new codebase?

You create developer documentation by generating a structured docs/ folder with index.md cross-linking architecture.md, setup.md, conventions.md, contributing.md, reference.md, and releases.md to guide contributors.

What sections should I include in a docs folder for contributor onboarding?

A docs folder for contributor onboarding should include index.md, architecture.md, setup.md, conventions.md, contributing.md, reference.md, and releases.md, plus a root CONTRIBUTING.md pointer to align teams on workflows and project organization.

What is the best way to document codebase architecture and contribution workflows?

The best way is drafting a six-section markdown structure covering architecture, setup, conventions, contributing, API references, and release procedures to help new engineers understand project organization and contribution workflows.

Can I generate an API reference and release procedures for an existing codebase?

Yes, you can generate project-scoped API reference and release procedures for existing codebases by drafting markdown files within a structured docs/ directory to align teams on technical references and release workflows.

Does this documentation approach work for both new libraries and existing projects?

Yes, this approach works for new libraries and existing projects by tailoring architecture, setup, conventions, and reference materials to the target codebase to accelerate onboarding and explain how to build, test, contribute, and release.

When do I need a root CONTRIBUTING.md pointer in my documentation structure?

You need a root CONTRIBUTING.md pointer when organizing a six-section docs/ structure to cross-link internal references and guide contributors from the repository root to detailed contribution workflows and conventions.