scribe

Generate and maintain README, API references, ADRs, changelogs, and runbooks.

5|Updated Feb 4, 2026
One-click install
npx skills add https://github.com/Rikinshah787/clawarmy --skill scribe-rikinshah787
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: scribe
Source: https://github.com/Rikinshah787/clawarmy/tree/main/.cursor/skills/scribe
Command: npx skills add https://github.com/Rikinshah787/clawarmy --skill scribe-rikinshah787

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that all project intelligence is meticulously logged, organized, and easily accessible, preventing valuable information from being lost or overlooked.

Core Features & Use Cases

  • Comprehensive Documentation: Generates and maintains READMEs, API docs, ADRs, changelogs, and runbooks.
  • Standardized Templates: Provides gold-standard templates for various documentation types to ensure consistency and quality.
  • Use Case: When a new feature is released, the Scribe skill can automatically update the README, generate a changelog entry, and ensure API documentation is current.

Quick Start

Use the scribe skill to generate a README file for the current project.

Frequently Asked Questions about scribe

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

FAQPage Schema
How do I generate a README file for my project?

You can generate a README by applying standardized templates that ensure audience-first, progressively disclosed, and searchable documentation, automating the creation process for your project.

What is the best way to maintain API references and TypeScript JSDoc?

Maintaining API references and TypeScript JSDoc is handled using specific templates and patterns for REST endpoints, ensuring your technical documentation remains current and adheres to established quality checklists.

How do I write an Architecture Decision Record (ADR) for a new feature?

Writing an Architecture Decision Record (ADR) is supported by gold-standard templates that meticulously log project intelligence, ensuring architectural choices are organized, accessible, and prevent information loss.

Can I automatically update a changelog when a new feature is released?

Yes, you can automatically update a changelog when a new feature is released; the skill generates changelog entries and ensures API documentation is current, preventing valuable information from being overlooked.

Does this tool work for generating runbooks and technical documentation?

Yes, this tool works for generating runbooks alongside READMEs, API docs, ADRs, and changelogs, providing comprehensive documentation automation that adheres to established quality checklists and avoids anti-patterns.

What are the limitations of using standardized documentation templates?

Standardized documentation templates ensure consistency and quality but require adherence to established patterns; if your project requires highly bespoke formats, you may need to adjust the provided REST endpoint or JSDoc patterns.