skills.rest
ArtisanClarinets
ArtisanClarinetsCOMMUNITY
Explore all skills by this author →
GitHub

documentation-writing

Standardize technical documentation writing for READMEs, API docs, and engineering guides.

Updated Dec 26, 2025
Search Tags:#documentation#communication#readme#structure#guidelines#api-docs
One-click install
npx skills add https://github.com/ArtisanClarinets/crispy-fishstick --skill documentation-writing-artisanclarinets
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-writing
Source: https://github.com/ArtisanClarinets/crispy-fishstick/tree/main/.agent/skills/documentation-writing
Command: npx skills add https://github.com/ArtisanClarinets/crispy-fishstick --skill documentation-writing-artisanclarinets

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill standardizes documentation writing for Project SENTINEL, improving clarity and consistency across engineering guides.

Core Features & Use Cases

  • Clear and consistent documentation guidelines for READMEs, API docs, and internal engineering guides.
  • Techniques for audience definition, structure, tone, diagrams, and versioning.
  • Use case: Teams produce high-quality docs that reduce support overhead and onboarding time.

Quick Start

  1. Define the target audience and purpose of the document.
  2. Choose an appropriate format (Markdown for general docs, MDX for interactive content) and outline the structure with clear headings.
  3. Review for clarity, accuracy, and consistency, then publish and link to related docs.

Frequently Asked Questions about documentation-writing

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

FAQPage Schema
How do I write clear API documentation and engineering guides?▼

Clear API documentation requires defining the target audience, outlining structure with headings in Markdown or MDX, and enforcing consistent terminology, diagrams, and peer-review workflows.

What is the best way to structure a technical README?▼

The best way to structure a technical README is to apply standardized guidelines: define audiences, maintain consistent terminology, use diagrams, and follow versioning and peer-review workflows for maintainability.

Does this documentation approach work with MDX for interactive content?▼

Yes, this documentation approach supports MDX for interactive content, alongside standard Markdown for general docs, allowing teams to structure technical guides with clear headings and consistent terminology.

How do I reduce onboarding time with internal engineering guides?▼

You reduce onboarding time by producing high-quality internal engineering guides that use defined audiences, structured formats, consistent terminology, and versioning to lower support overhead and improve clarity.

When do I need versioning and peer-review workflows for technical documentation?▼

You need versioning and peer-review workflows for technical documentation when standardizing engineering guides to ensure maintainability, accuracy, and consistency across READMEs and API docs.

Related Skills

Explore More Content & Communication Skills→
GitLaw-coGitLaw-co

create-documentation

Create Markdown/MDX documentation pages for Documenso features and modules.

Official
Intermediate
JLSedJLSed

rust-documentation

Standardize Rust and WebAssembly documentation with rustdoc conventions and security notes.

Community
Intermediate
leaderiopleaderiop
7

Documentation Docusaurus

Enforce Docusaurus coding standards across MDX/Markdown content, configuration, and navigation.

Community
Intermediate
forwardimpactforwardimpact
4

libs-web-presentation

Convert Markdown to HTML and generate static documentation sites.

Official
Intermediate