skills.rest
kshehadeh
kshehadehCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

update-documentation

Manage project documentation with file location and naming conventions.

Updated Dec 30, 2025
Search Tags:#documentation#writing#content management#readme#organization#docs
One-click install
npx skills add https://github.com/kshehadeh/prompt --skill update-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-documentation
Source: https://github.com/kshehadeh/prompt/tree/main/.agents/skills/update-documentation
Command: npx skills add https://github.com/kshehadeh/prompt --skill update-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides clear guidelines on how to add, update, and organize project documentation, ensuring consistency and maintainability.

Core Features & Use Cases

  • Documentation Standards: Defines where documentation should live (docs/ folder) and naming conventions (UPPERCASE filenames).
  • Colocation Strategy: Guides users on whether to update existing documents or create new ones based on the scope of the change.
  • Workflow Guidance: Outlines a simple process for deciding where content belongs and how to implement changes.
  • Use Case: When you need to add a new section explaining a new feature to the project's documentation, this skill will tell you exactly which file to update or if a new file needs to be created.

Quick Start

Use the update-documentation skill to add a new section about the image upload process to the documentation.

Frequently Asked Questions about update-documentation

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

FAQPage Schema
How do I organize project documentation files for software projects?▼

Update existing documentation when the change modifies current features, or create a new document when introducing entirely separate functionality. This colocation workflow maintains documentation clarity and prevents excessive file bloat.

What naming conventions should I use for project documentation files?▼

Use this documentation workflow when you need to add a new section explaining a feature or establish organization standards for project docs. It is suited for software projects requiring clear, accessible, and maintainable content management.

How do I add a new section to project documentation?▼

Adhering to established documentation standards provides clear guidelines on adding, updating, and organizing project documentation. This approach differs from ad-hoc writing by enforcing file location and naming conventions for long-term maintainability.

When should I create a new documentation file instead of updating an existing one?▼

Create a new documentation file when the scope of the change introduces a distinct feature outside existing content boundaries. Update existing documents when modifying or expanding upon already documented functionalities.

Related Skills

Explore More Software Engineering Skills→
telum-aitelum-ai
2

project-import

Create a Speck project structure with a skeleton project.md file.

Official
Basic
microsoftmicrosoft
2.9k

wiki-vitepress

Package wiki Markdown into a VitePress static site with dark theme and Mermaid diagrams.

Official
Advanced
auldsyababuaauldsyababua
6

markdown-validation

Validate Markdown files for syntax, links, and formatting standards.

Community
Advanced
FaysilAlshareefFaysilAlshareef
4

api-docs

Enrich OpenAPI specifications with summaries, descriptions, and examples.

Community
Intermediate