skills.rest
russosalv
russosalvCOMMUNITY
Explore all skills by this author →
GitHub

bmad-agent-tech-writer

Transform complex technical concepts into structured documentation for software projects.

5|Updated Apr 18, 2026
Search Tags:#documentation#mermaid#readme#brownfield#technical-writing#developer-docs#docs-audit
One-click install
npx skills add https://github.com/russosalv/NONoise --skill bmad-agent-tech-writer-russosalv
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-agent-tech-writer
Source: https://github.com/russosalv/NONoise/tree/main/packages/skills/bmad-agent-tech-writer
Command: npx skills add https://github.com/russosalv/NONoise --skill bmad-agent-tech-writer-russosalv

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Transforms complex technical concepts, scattered notes, and incomplete project artifacts into clear, actionable documentation that developers and stakeholders can use to onboard, implement, and maintain software systems.

Core Features & Use Cases

  • Documentation authoring: Draft and update README.md, guides, API narratives, and implementation plans tailored to the audience.
  • Brownfield analysis: Scan existing repos and docs to produce project overviews and architecture write-ups via reverse-engineering workflows.
  • Diagrams & standards: Produce Mermaid-compliant diagrams, OpenAPI-friendly docs, and ensure consistency across CLAUDE.md, AGENTS.md, and copilot-instructions.md.
  • Handoff-ready artifacts: Create structured plans and release notes, and integrate with NONoise skills like superpowers:writing-plans for plan generation.

Quick Start

Ask Daniel to audit the repository documentation, produce an updated README.md, and include a Mermaid diagram summarizing the architecture.

Frequently Asked Questions about bmad-agent-tech-writer

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

FAQPage Schema
How do I generate developer documentation for an existing brownfield repository?▼

To audit existing project documentation, scan repository files like docs/, CLAUDE.md, and AGENTS.md to evaluate completeness and consistency. The audit produces structured overviews identifying gaps and recommending updates across all developer instruction files.

Can I create Mermaid architecture diagrams from my repository files?▼

Yes, you can create Mermaid-compliant architecture diagrams directly from repository files. The skill transforms complex technical concepts into visual diagrams, summarizing system architecture for inclusion in README updates and developer guides.

What is the best way to structure implementation plans and release notes for developers?▼

The best way to structure implementation plans and release notes is to transform scattered notes into handoff-ready artifacts. By integrating plan generation workflows, the skill creates structured plans tailored for developer onboarding and system maintenance.

Do I need specific repository files to start authoring technical documentation?▼

Yes, you need access to repository files such as docs/, CLAUDE.md, and AGENTS.md. Accessing these files allows the skill to ensure consistency across copilot-instructions.md and produce OpenAPI-friendly documentation.

Does this technical writing skill work with greenfield and brownfield software projects?▼

Yes, this technical writing skill works with both greenfield and brownfield software projects. It transforms incomplete project artifacts into actionable documentation, handling API narratives and implementation plans for new and existing systems alike.

Why ensure consistency across CLAUDE.md and AGENTS.md when writing developer docs?▼

Ensuring consistency across CLAUDE.md and AGENTS.md aligns automated coding assistants and developer instructions. Maintaining uniform documentation standards prevents conflicting guidance and improves the accuracy of generated implementation plans.

Related Skills

Explore More Content & Communication Skills→
fyrsmithlabsfyrsmithlabs

git-repo-standards

Validate repository naming, structure, documentation, and security files against project standards.

Official
Intermediate
earchibaldearchibald
70

executing-plans

Execute implementation plans in controlled batches with review checkpoints.

Community
Intermediate
JosephWoodallJosephWoodall
1

parallel-web

Search the web and generate citation-rich summaries via the Parallel Chat API.

Community
Advanced
henrybravohenrybravo

documentation-synthesis

Generate Markdown documentation from code comments and OpenAPI or GraphQL schemas.

Community
Advanced