skills.rest
TurnaboutHero
TurnaboutHeroCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

scribe

Generate READMEs, API references, and architecture guides from project notes.

12|4|Updated Jan 22, 2026
Search Tags:#documentation#writing#contributing#guides#API docs#README
One-click install
npx skills add https://github.com/TurnaboutHero/oh-my-antigravity --skill scribe-turnabouthero
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: scribe
Source: https://github.com/TurnaboutHero/oh-my-antigravity/tree/main/skills/scribe
Command: npx skills add https://github.com/TurnaboutHero/oh-my-antigravity --skill scribe-turnabouthero

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scribe helps teams produce accurate, accessible documentation (READMEs, API docs, and guides) with consistent structure and terminology, reducing onboarding time and support queries.

Core Features & Use Cases

  • Documentation Mastery: Generate comprehensive README, API references, and architecture guides from project notes.
  • Consistency & Style: Enforce a consistent documentation style across files and versions.
  • Use Case: For a new open-source project, generate a ready-to-publish README, CONTRIBUTING guide, and API reference.

Quick Start

Use the scribe skill to generate a complete README and API reference for a sample project.

Frequently Asked Questions about scribe

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

FAQPage Schema
How do I create a professional README that helps users understand my project quickly?▼

Scribe generates structured READMEs with consistent sections—overview, installation, usage, and contribution guidelines—reducing onboarding time and support questions. It uses frontmatter-driven templates to ensure every README follows the same clear format.

Can I generate API documentation that stays consistent across multiple projects?▼

Yes. Scribe enforces consistent documentation style and terminology across API references and guides. It applies the same structured template and section guidelines to every file, making your documentation predictable and maintainable across versions.

What's the best way to document architecture and contributing guidelines alongside a README?▼

Scribe generates comprehensive documentation suites including READMEs, architecture guides, and CONTRIBUTING files from your project notes. It applies unified style and structure so all guides feel cohesive and ready to publish immediately.

How do I ensure my open-source project documentation is accessible and complete from the start?▼

Scribe creates ready-to-publish documentation sets for new projects by generating structured READMEs, API references, and guides simultaneously. Its template-driven approach guarantees nothing is missing and all sections follow accessibility and consistency standards.

Does documentation generation work for projects with multiple file types and frameworks?▼

Scribe targets READMEs, API references, and architecture guides across software projects regardless of tech stack. It produces consistent, maintainable output by applying its structured frontmatter template universally, not tied to specific frameworks.

Related Skills

Explore More Content & Communication Skills→
allen-hsuallen-hsu
1

writing-tech-specs

Generate standardized technical specification documents through a guided Q&A workflow.

Community
Advanced
chekoschekos
5

docs-as-code

Automate documentation workflows with versioning, validation, and CI/CD deployment.

Community
Intermediate
fredrikaverpilfredrikaverpil
253

git-commit

Validate git commit messages against the Conventional Commits specification.

Community
Basic
FatByFatBy
2

mintlify

Create and maintain Mintlify documentation sites with MDX and docs.json.

Community
Intermediate