skills.rest
LedgerHQ
LedgerHQOFFICIAL
Explore all skills by this author →
WebsiteGitHub

docs-update-or-create

Guides creation and updating of repository documentation following progressive disclosure principles.

615|491|Updated Jan 4, 2022
Search Tags:#writing#Markdown#Documentation#canonicalization#FrontMatter#AGENTS#Progressive Disclosure
One-click install
npx skills add https://github.com/LedgerHQ/ledger-live --skill docs-update-or-create
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-update-or-create
Source: https://github.com/LedgerHQ/ledger-live/tree/main/.agents/skills/docs-update-or-create
Command: npx skills add https://github.com/LedgerHQ/ledger-live --skill docs-update-or-create

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation in large repositories often becomes duplicated, bloated, or hard to discover. This Skill enforces consistent guidelines when creating or updating docs so content stays minimal, canonical, and discoverable by both humans and AI agents.

Core Features & Use Cases

  • Structured doc workflow: Follows a five-step process from understanding the topic to validating the result.
  • Frontmatter standards: Defines conventions for name, description, allowed-tools, and invocation flags so skills and agents are tool-discoverable.
  • Quality principles: Applies progressive disclosure, docs locality, and canonicalization rules, with validation steps using rg and wc -l.
  • Use Case: When adding a new guide under docs/ or updating AGENTS.md in the ledger-live monorepo, use this Skill to decide the right location, keep the file under roughly 100 lines, and avoid duplicating existing knowledge.

Quick Start

Ask the agent to create or update a documentation file in this repo while following the docs-update-or-create guidelines.

Frequently Asked Questions about docs-update-or-create

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

FAQPage Schema
How do I create documentation that AI agents can discover?▼

Add YAML frontmatter with `name` and `description` fields to skill and agent definition files so tools can index them. Keep the body concise and link to narrower docs for deeper detail.

What is progressive disclosure in documentation?▼

Progressive disclosure means keeping each file at one level of detail and linking to narrower documents when content must branch. This avoids long files that overload context with rarely used knowledge.

How long should a documentation file be?▼

Treat 100 lines as a target, not a hard limit. Keep content short and direct, use short inline examples instead of long embedded ones, and verify length with `wc -l` during validation.

When should I use frontmatter in README files?▼

Frontmatter is optional for READMEs and should be included only when useful. Skill and agent definitions require it for tool discoverability, while plain docs can omit it.

How do I avoid duplicating documentation across a repo?▼

Apply canonicalization rules so each piece of knowledge lives in one canonical location, then link to it. During validation, search for duplicated key phrases with `rg` to catch accidental copies.

Related Skills

Explore More Software Engineering Skills→
LoringtonianLoringtonian
12

explore-second-brain

Find existing second-brain files related to new input before merging.

Community
Advanced
furiosa-aifuriosa-ai
1

update-docs

Incorporate PR comments into documentation files with source citations.

Official
Advanced
kent013kent013

zenigame-fx-update-docs

Audit Alpha Factory docs against source code and update outdated terminology.

Community
Intermediate
10knamesmore10knamesmore

doc-comment-adder

Add or complete documentation comments to Rust and TypeScript code.

Community
Basic