documentation-principles

Name: documentation-principles
Availability: InStock
Author: Lore

Apply documentation principles to link content and prevent duplication.

Updated Aug 23, 2026

Search Tags:#documentation #principles #conciseness #linking #docs-maintenance #avoid-duplication

Ready to run

npx skills add https://github.com/lorehq/lore --skill documentation-principles-lorehq

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-principles
Source: https://github.com/lorehq/lore/tree/main/.lore/skills/documentation-principles
Command: npx skills add https://github.com/lorehq/lore --skill documentation-principles-lorehq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation principles help prevent duplication, reduce outdated information, and ensure all docs stay current and coherent.

Core Features & Use Cases

Don't Duplicate: Link to existing information instead of repeating it.
Keep It Short: One topic per page; avoid filler; concise prose.
Don't Let Docs Rot: Update docs whenever the code changes and remove outdated content.

Quick Start

Instruct Lore to apply documentation principles when creating or updating project documentation.

Frequently Asked Questions about documentation-principles

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

FAQPage Schema

How do I prevent documentation duplication and outdated information across READMEs?▼

To prevent documentation duplication, link to existing information instead of repeating it across READMEs and knowledge bases. This approach ensures content stays current and coherent while reducing maintenance overhead.

What is the best way to keep project docs updated when code changes?▼

The best way to keep project docs updated is to enforce updating documentation whenever code changes occur. This prevents docs rot and removes outdated information, ensuring in-code docs and commit messages remain accurate.

How do I structure concise documentation for new feature introductions?▼

Structure concise documentation by limiting one topic per page and avoiding filler prose. When introducing new features, apply these documentation principles to maintain clarity and reduce outdated content.

Why does linking instead of repeating content help with docs maintenance?▼

Linking instead of repeating content helps with docs maintenance by eliminating duplication across knowledge bases and in-code docs. This ensures updates only need to happen in one place, preventing rot and keeping information coherent.

Can I apply documentation principles to commit messages and in-code docs?▼

Yes, you can apply documentation principles to commit messages and in-code docs. These principles span multiple formats including READMEs, knowledge bases, and cross-reference tasks, ensuring all project documentation stays clear and concise.

When should I remove outdated documentation from a knowledge base?▼

You should remove outdated documentation from a knowledge base whenever code changes occur. Applying documentation principles means actively eliminating outdated information and updating content to prevent docs rot across all project materials.