skills.rest
majedsiefalnasr
majedsiefalnasrCOMMUNITY
Explore all skills by this author →
Website𝕏@majedsiefalnasrGitHub

documentation-writer-protocol

Standardize ADR and API endpoint documentation workflows with bilingual guidelines.

Updated Apr 10, 2026
Search Tags:#documentation#adr#protocol#governance#guidelines#bilingual#api-docs
One-click install
npx skills add https://github.com/majedsiefalnasr/bunyan-app-cursor --skill documentation-writer-protocol
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-writer-protocol
Source: https://github.com/majedsiefalnasr/bunyan-app-cursor/tree/main/.agents/skills/documentation-writer-protocol
Command: npx skills add https://github.com/majedsiefalnasr/bunyan-app-cursor --skill documentation-writer-protocol

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This protocol standardizes and streamlines the creation of Architecture Decision Records (ADRs) and API endpoint documentation, ensuring consistent governance across projects and teams.

Core Features & Use Cases

  • Immutability: ADRs are immutable once accepted, and new ADRs supersede older ones to capture evolving decisions.
  • Multi-format docs: Guidance covers ADRs, API docs, and root README documentation for major directories with bilingual support (Arabic and English where applicable).
  • Automation-friendly: Designed to feed OpenAPI specs and code comments into generated docs while preserving human-readable context.
  • Quick-start workflows: Provides a simple, repeatable sequence to draft and review documentation for new components.

Quick Start

Draft ADRs and API documentation for a new component using this protocol.

Frequently Asked Questions about documentation-writer-protocol

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

FAQPage Schema
How do I standardize Architecture Decision Records across multiple software projects?▼

Architecture Decision Records (ADRs) should be standardized by enforcing immutability once accepted, using new ADRs to supersede older ones. This captures evolving decisions while maintaining consistent, audit-ready governance across multiple software projects.

What is the best way to generate API documentation from OpenAPI specs?▼

Generating API documentation from OpenAPI specs is best handled by an automation-friendly protocol that feeds specifications and code comments into generated docs. This preserves human-readable context while auto-generating accurate API endpoint references.

How does an immutable ADR workflow handle changing architecture decisions?▼

An immutable ADR workflow handles changing architecture decisions by keeping accepted records permanently unchanged. When a decision evolves, a new ADR is created to supersede the older one, capturing the full historical context for audit readiness.

Can I create bilingual technical documentation for API endpoints and READMEs?▼

Yes, you can create bilingual technical documentation for API endpoints and root READMEs. The protocol provides guidelines supporting bilingual outputs, such as Arabic and English, ensuring comprehensive technical docs across major directories.

Does this documentation protocol support automated review workflows for new components?▼

Yes, this documentation protocol supports automated review workflows for new components by providing a quick-start sequence to draft and review ADRs and API documentation. The automation-friendly design feeds code comments into the generated docs.

Related Skills

Explore More Content & Communication Skills→
7a336e6e7a336e6e
1

Writing Documentation

Generate README files, API specifications, and architecture decision records for software projects.

Community
Intermediate
MoffranMoffran
78

ce-rtd-auditor

Audits ReadTheDocs projects for navigation, accuracy, and ADR consistency, generating severity-ranked findings.

Community
Intermediate
anishi1222anishi1222

documentation-check

Review README, API specifications, and code comments for documentation quality.

Community
Basic
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic