skills.rest
LukasStrickler
LukasStricklerCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

docs-write

Create and maintain project-standard documentation with Markdown, Mermaid, and PlantUML diagrams.

4|Updated Dec 14, 2025
Search Tags:#templates#documentation#writing#markdown#mermaid#plantuml#cross-references
One-click install
npx skills add https://github.com/LukasStrickler/ai-dev-atelier --skill docs-write-lukasstrickler
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-write
Source: https://github.com/LukasStrickler/ai-dev-atelier/tree/main/content/skills/docs-write
Command: npx skills add https://github.com/LukasStrickler/ai-dev-atelier --skill docs-write-lukasstrickler

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill enables teams to generate and maintain documentation that adheres to a consistent, high-quality standard across tutorials, how-tos, references, explanations, ADRs, and runbooks. It addresses the pain points of scattered notes, inconsistent terminology, and outdated docs by providing structured guidance and templates.

Core Features & Use Cases

  • Template-driven documentation: Creates consistent docs aligned with the project's style guide.
  • Doc-type guidance: Supports tutorials, how-tos, references, explanations, ADRs, and runbooks with clear structures.
  • Visual integration: Encourages inline Mermaid diagrams and PlantUML diagrams for reproducible visuals, and cross-referencing between docs.
  • Quick editing: Helps update docs in PRs when code changes occur and ensures documentation coverage for API endpoints, configurations, and architecture.

Quick Start

Read references/documentation-guide.md to understand the standards. Then draft your documentation by selecting a doc type (Tutorial, How-to, Reference, or Explanation) and applying the recommended structure. Finally, run the docs-check script to validate updates and publish to your repository.

Frequently Asked Questions about docs-write

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

FAQPage Schema
How do I create consistent documentation templates for tutorials and references?▼

To create consistent documentation templates, select a specific doc type like a tutorial or reference, then apply the structured guidance from the project's style guide to generate ready-to-publish Markdown files. This ensures standardized terminology and structure across all docs.

Can I use Mermaid and PlantUML diagrams in my Markdown documentation?▼

Yes, you can include Mermaid and PlantUML diagrams directly in your Markdown documentation. The skill supports inline visual integration, allowing you to generate reproducible diagrams and cross-references between related documents for clearer architectural explanations.

What is the best way to update outdated documentation during code changes?▼

The best way to update documentation during code changes is to apply template-driven structures to existing tutorials and runbooks within your PR. This enforces coverage for API endpoints and configurations, ensuring docs remain accurate and synchronized with deployments.

Does this documentation skill support Architecture Decision Records and runbooks?▼

Yes, this documentation skill fully supports generating Architecture Decision Records (ADRs) and runbooks alongside tutorials, how-tos, and explanations. It provides specific structural guidance to maintain high-quality standards for these specialized doc types.

How do I validate documentation updates before publishing to a repository?▼

You validate documentation updates by running the docs-check script after drafting your Markdown content. This verifies that your tutorials, references, and explanations adhere to the project's style guide and cross-reference standards before you publish to the repository.

Related Skills

Explore More Content & Communication Skills→
tmforum-odatmforum-oda
53

canvas-usecase-documentation

Standardize ODA Canvas documentation across Markdown, PlantUML, and Helm-chart docs.

Official
Intermediate
Mr-Fang-VLSIMr-Fang-VLSI
8

eda-system-packager

Package agent and skill infrastructure into a repository-ready bundle.

Community
Advanced
HybridAIOneHybridAIOne
126

diagram

Generate and validate diagram-as-code artifacts in Mermaid, PlantUML, Graphviz DOT, or Excalidraw JSON.

Official
Advanced
freedomw1987freedomw1987
2

auto-doc-gen

Generate and synchronize Markdown API documentation from code comments.

Community
Intermediate