skills.rest
micaelmalta
micaelmaltaCOMMUNITY
Explore all skills by this author →
𝕏@micael_nycGitHub

documentation

Automate creation and synchronization of README, API docs, ADRs, and inline comments.

1|Updated Feb 2, 2026
Search Tags:#documentation#readme#ADR#API docs#runbooks#inline docs
One-click install
npx skills add https://github.com/micaelmalta/agentic --skill documentation-micaelmalta
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/micaelmalta/agentic/tree/main/skills/documentation
Command: npx skills add https://github.com/micaelmalta/agentic --skill documentation-micaelmalta

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drift is reduced by automating the creation and synchronization of README, API docs, ADRs, and inline documentation.

Core Features & Use Cases

  • Automated documentation scaffolding: Generate README sections, API docs, and ADR templates from code or usage notes.
  • Inline documentation & runbooks: Insert docstrings and runbooks to explain public APIs and operational steps.
  • Use Case: When a feature is added or changed, automatically update relevant docs to reflect behavior and provide examples.

Quick Start

Run the documentation skill to generate an initial README for a new project and scaffold an ADR for a planned architecture.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I keep documentation in sync with code changes automatically?▼

To keep documentation in sync, this Skill automates the creation and synchronization of README files, API docs, ADRs, and inline comments whenever features are added, refactored, or APIs change.

What is the best way to generate an initial README and ADR templates for a new project?▼

The best way to generate an initial README and ADR templates is to run this Skill, which scaffolds documentation from code or usage notes to establish consistent project architecture records.

How do I automatically update API docs and inline comments after a refactor?▼

To update API docs and inline comments after a refactor, this Skill applies enforced templates and inserts docstrings to reflect behavior changes and provide operational examples.

Can I automate runbook creation for software projects of any size?▼

Yes, you can automate runbook creation for software projects of any size. The Skill inserts runbooks to explain public APIs and operational steps alongside standard documentation.

Does this documentation automation work for both feature additions and API changes?▼

Yes, this documentation automation works for both feature additions and API changes. It enforces templates for README, API docs, ADRs, and runbooks to deliver consistent, up-to-date content aligned with code intent.

Related Skills

Explore More Content & Communication Skills→
Snowflake-LabsSnowflake-Labs
12

read-ors-configuration

A concise summary of your roleplay character: name,</name> personality, and/or behavior, formatted as a single string sentence. Typically不超过50字，此处省略

Official
Intermediate
Anders-planckAnders-planck

docs-management

Standardize technical documentation creation, review, and publishing with templates and validation.

Community
Intermediate
pradyumnasagarpradyumnasagar
6

agent-handoff

Automate inter-skill data transfer and provenance capture via JSON Material Passports.

Community
Advanced
shakhovskiya-createshakhovskiya-create

docs-audit

Audit project documentation for drift between code, ADRs, and READMEs.

Community
Intermediate