Does this skill support Mermaid diagrams?

Yes, it provides patterns and templates for creating flowcharts, sequence diagrams, and entity-relationship diagrams using Mermaid syntax directly within your documentation.

What is an ADR and how does this skill help?

An Architecture Decision Record (ADR) documents significant design choices. This skill provides templates to capture the status, context, decision, and consequences of these choices.

Does it help with inline code comments?

Yes, the skill includes JSDoc patterns and best practices for explaining the 'why' behind complex logic rather than just stating the obvious.

Can I use this for REST API documentation?

Absolutely. It includes specific structures for documenting HTTP endpoints, including tables for request parameters, JSON response examples, and status codes.

Technical Documentation

Name: Technical Documentation
Author: srstomp

bysrstomp

•

Learning & Documentation

Generates and maintains professional technical documentation, including READMEs, API references, and Architecture Decision Records.

The Technical Documentation skill enables Claude to act as a specialized technical writer within your development environment. It provides structured patterns and templates for creating clear, maintainable documentation that lives alongside your code. From generating 'Quick Start' READMEs and detailed API endpoint references to recording complex system design choices via Architecture Decision Records (ADRs), this skill ensures your project remains well-documented for both users and contributors. It also supports Mermaid diagrams for visual modeling and JSDoc patterns for inline code documentation.

Key Features

01Comprehensive API documentation patterns with request/response examples

02Mermaid diagram support for flowcharts, sequence diagrams, and ERDs

03Standardized README generation with proven sections (What, Why, How, More)

042 GitHub stars

05Audience-first writing guidelines and JSDoc implementation patterns

06Architecture Decision Record (ADR) templates for tracking design rationale

Use Cases

01Recording the context and consequences of major architectural shifts using a structured ADR format

02Documenting a new REST API including endpoint parameters, JSON examples, and error codes

03Building a comprehensive project entry point with a 'Quick Start' guide and installation instructions

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add srstomp/pokayokay documentation

For use in Claude.ai and ChatGPT

Download Skill