skills.rest
watchthelight
watchthelightCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

gds-agent-tech-writer

Generates and validates CommonMark-compliant technical documentation with Mermaid diagrams for game projects.

Updated Sep 3, 2026
Search Tags:#game development#documentation#mermaid#technical writing#style guide#diagram generation#commonmark
One-click install
npx skills add https://github.com/watchthelight/shatterfish --skill gds-agent-tech-writer-watchthelight
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: gds-agent-tech-writer
Source: https://github.com/watchthelight/shatterfish/tree/main/.claude/skills/gds-agent-tech-writer
Command: npx skills add https://github.com/watchthelight/shatterfish --skill gds-agent-tech-writer-watchthelight

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Game projects accumulate scattered knowledge that designers, engineers, and future AI agents struggle to consume. This Skill provides a Technical Writer persona (Paige) that authors, validates, and maintains structured documentation following strict CommonMark and style standards. ## Core Features & Use Cases - Document Authoring: Write READMEs, API references, user guides, and architecture docs through guided conversation following documentation-standards.md best practices. - Standards Validation: Review existing documents against CommonMark rules, style guidelines, and a quality checklist, returning prioritized improvement suggestions. - Mermaid Diagram Generation: Create flowcharts, sequence diagrams, class diagrams, and ER diagrams with valid Mermaid v10+ syntax. - Use Case: A game studio needs architecture documentation for a new engine module. Invoke the writer, describe the system, and receive a standards-compliant document with component diagrams ready for the project wiki. ## Quick Start Ask Paige to write an architecture document for your game project following the documentation standards.

Frequently Asked Questions about gds-agent-tech-writer

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

FAQPage Schema
How do I write technical documentation that follows CommonMark standards?▼

Invoke the write-document workflow, which guides you through clarifying scope, audience, and purpose before drafting. The output follows documentation-standards.md rules including ATX headers, fenced code blocks with language tags, and consistent list markers.

How to validate existing documentation against style guidelines?▼

Use the validate-doc workflow with the target document path. It reviews the file against documentation-standards.md covering CommonMark compliance, clarity, structure, and audience fit, then returns a prioritized list of actionable improvements.

Can I generate Mermaid diagrams for architecture documentation?▼

Yes, the mermaid-gen workflow creates flowcharts, sequence diagrams, class diagrams, ER diagrams, and state diagrams using valid Mermaid v10+ syntax. It suggests diagram types based on your description and iterates on feedback.

How do I customize the technical writer persona behavior?▼

Edit the customize.toml file to override the agent's role, communication style, principles, and menu items. Team and user-level TOML overrides merge structurally with the base configuration following BMad merge rules.

What documentation types does this skill support?▼

It supports READMEs, API references with OpenAPI elements, user guides, architecture documents with ADRs, and developer guides. Each type has defined structural requirements in documentation-standards.md.

Related Skills

Explore More Content & Communication Skills→
CERTCCCERTCC
21

study-project-docs

Aggregate specifications, design decisions, and key documentation across repositories.

Official
Intermediate
Unique-AGUnique-AG
5

entangled-mkdocs

Generate annotated Markdown pages and update navigation for Entangled MkDocs sites.

Official
Intermediate
darelabs-techdarelabs-tech

dare-patterns

Mine brownfield software patterns via AST analysis to generate architectural documentation and JSON facts.

Official
Intermediate
jikimejikime
5

jikime-workflow-docs

Generate API documentation and static doc sites from code using Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Intermediate