skills.rest
RyderFreeman4Logos
RyderFreeman4LogosCOMMUNITY
Explore all skills by this author →
𝕏@wuzhige4pixelGitHub

csa-doc-writing

Provide documentation guidelines for APIs, READMEs, ADRs, and changelogs.

12|1|Updated Feb 6, 2026
Search Tags:#changelog#templates#documentation#adr#readme#docs
One-click install
npx skills add https://github.com/RyderFreeman4Logos/cli-sub-agent --skill csa-doc-writing
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: csa-doc-writing
Source: https://github.com/RyderFreeman4Logos/cli-sub-agent/tree/main/dev/skills/csa-doc-writing
Command: npx skills add https://github.com/RyderFreeman4Logos/cli-sub-agent --skill csa-doc-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Clear, practical documentation guidance for APIs, README files, architecture decisions, and changelogs to improve consistency, onboarding, and maintenance.

Core Features & Use Cases

  • Code documentation guidelines for Rust and public APIs, including doc comments and examples.
  • README structure guidance to standardize project introductions, usage, and contribution notes.
  • ADR and CHANGELOG formats to capture decisions and release notes in a deterministic, readable form.
  • Documentation workflow outlining Analysis, Synthesis, and Write steps to produce high-quality docs.
  • Checklist-based quality assurance to ensure documentation accuracy and completeness.

Quick Start

Follow the structured workflow to document a new module: analyze the code, draft the API docs and ADRs, and publish a changelog.

Frequently Asked Questions about csa-doc-writing

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

FAQPage Schema
How do I write API documentation for Rust projects?▼

Rust API documentation uses doc comments with examples to ensure clarity. This Skill provides guidelines for standardizing code documentation, including structured workflows to analyze code, draft API docs, and publish consistent references.

What is the best way to structure a README for software onboarding?▼

A standardized README structure improves project onboarding by clearly separating introductions, usage instructions, and contribution notes. Following a deterministic format ensures users can quickly understand and adopt the codebase.

How do I format architecture decision records and changelogs?▼

Formatting architecture decision records and changelogs involves capturing decisions and release notes in a deterministic, readable form. This ensures consistent documentation of architectural changes and release updates across software projects.

What workflow should I follow to generate consistent project documentation?▼

Generating consistent project documentation follows a workflow of Analysis, Synthesis, and Write steps. This process ensures high-quality docs by guiding you from code analysis through drafting to final publication with checklist-based quality assurance.

Can I use these documentation guidelines for languages other than Rust?▼

The documentation guidelines target Rust and public APIs specifically, including Rust doc-comment examples. While the README, ADR, and changelog formats apply broadly, code documentation examples are tailored for Rust projects.

Related Skills

Explore More Content & Communication Skills→
franroafranroa

Architecture Designer

Design scalable software architectures and document decisions with ADRs.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
DidierRLopesDidierRLopes
8

convert-beehiiv-newsletter

Convert Beehiiv newsletter posts into blog markdown files with front matter and images.

Community
Advanced
JansenAnalyticsJansenAnalytics
5

doc-generator

Generate README, JSDoc comments, and API documentation from codebases.

Community
Advanced