skills.rest
JHAMILCALI
JHAMILCALICOMMUNITY
Explore all skills by this author →
GitHub

bri-tech-writer

Generates technical documentation, Mermaid diagrams, and documentation validation reports through guided conversation.

Updated Sep 6, 2026
Search Tags:#documentation#markdown#mermaid#technical writing#knowledge curation#diagrams#doc validation
One-click install
npx skills add https://github.com/JHAMILCALI/Stellar-Build --skill bri-tech-writer-jhamilcali
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bri-tech-writer
Source: https://github.com/JHAMILCALI/Stellar-Build/tree/main/.claude/skills/bri-tech-writer
Command: npx skills add https://github.com/JHAMILCALI/Stellar-Build --skill bri-tech-writer-jhamilcali

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping project documentation accurate, structured, and audience-appropriate is time-consuming, and teams often lack a consistent process for writing docs, creating diagrams, and validating content against standards. ## Core Features & Use Cases - Document Authoring: Guides you through multi-turn conversation to draft well-structured documents following documentation best practices. - Diagram Generation: Creates Mermaid-compliant diagrams (flowcharts, sequence, class, ER) from natural-language descriptions. - Documentation Validation: Reviews existing documents against clarity, structure, and audience-appropriateness standards with prioritized improvement suggestions. - Use Case: Ask Bri to document a brownfield codebase, then generate an architecture diagram in Mermaid and validate the resulting guide before publishing it to your team wiki. ## Quick Start Ask Bri to write a getting-started guide for your project and include a Mermaid architecture diagram.

Frequently Asked Questions about bri-tech-writer

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

FAQPage Schema
How do I generate technical documentation for an existing codebase?▼

Invoke the tech writer and select the documentation menu item to run a brownfield analysis and architecture scan. The skill guides you through scope and audience questions, then drafts structured documentation following best practices.

How to create a Mermaid diagram from a text description?▼

Use the diagram generation menu option and describe what you want to visualize. The skill suggests a diagram type such as flowchart, sequence, class, or ER, then produces Mermaid syntax in a fenced code block ready to render.

Can I customize the tech writer persona and menu?▼

Yes, the customize.toml file defines the agent's role, communication style, principles, persistent facts, and menu items. Team and user-level TOML overrides merge structurally, letting you adjust behavior without changing the core identity.

Does the documentation validation check custom standards?▼

Yes, validation reviews documents against general documentation best practices plus any additional focus areas you specify. It returns a prioritized list of specific, actionable improvement suggestions.

What are the limitations of automated documentation generation?▼

Generated documentation quality depends on the clarity of your answers during the discovery conversation and available project context files. Complex domains may require multiple review iterations and manual verification of technical accuracy.

Related Skills

Explore More Content & Communication Skills→
wsmanwsman
18

project-stage-detect

Scan repository artifacts to classify project stage and report gaps.

Community
Advanced
microsoftmicrosoft
2.9k

wiki-vitepress

Package wiki Markdown into a VitePress static site with dark theme and Mermaid diagrams.

Official
Advanced
tendercoconut174tendercoconut174

change-docs-skill

Updates README, docs, and Cursor skills after every code change.

Community
Basic
beelabstudiobeelabstudio

documentation-writer

Creates and maintains technical documentation, API docs, README files, and user guides.

Official
Basic