skills.rest
a-jay85
a-jay85COMMUNITY
Explore all skills by this author →
GitHub

documentation-updates

Update IBL5 project documentation files during pull requests and feature development.

1|Updated Jan 26, 2020
Search Tags:#documentation#pull request#refactoring#readme#code standards#ib5
One-click install
npx skills add https://github.com/a-jay85/IBL5 --skill documentation-updates-a-jay85
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-updates
Source: https://github.com/a-jay85/IBL5/tree/main/.claude/skills/documentation-updates
Command: npx skills add https://github.com/a-jay85/IBL5 --skill documentation-updates-a-jay85

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates and standardizes the process of updating documentation for the IBL5 project, ensuring consistency and completeness across various project artifacts.

Core Features & Use Cases

  • PR Documentation: Guides users on updating STRATEGIC_PRIORITIES.md and REFACTORING_HISTORY.md during pull requests.
  • Component READMEs: Facilitates the creation of standardized README.md files for individual modules.
  • Development Guide Updates: Assists in maintaining the DEVELOPMENT_GUIDE.md with current module counts and statuses.
  • Use Case: When a new feature is merged, this skill ensures all relevant documentation files are updated according to the project's standards.

Quick Start

Update the IBL5 documentation for the new Player module by following the PR checklist.

Frequently Asked Questions about documentation-updates

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

FAQPage Schema
How do I update IBL5 project documentation during a pull request?▼

Updating IBL5 documentation during a pull request involves managing strategic priorities, refactoring history, component READMEs, and development guides. It ensures adherence to file naming and content standards for guides and component documentation.

What is the best way to standardize component READMEs for new modules?▼

Standardizing component READMEs requires creating standardized README.md files for individual modules. This approach maintains file naming and content standards for component documentation, ensuring consistency and completeness across the project.

When do I need to update the development guide for a merged feature?▼

You need to update the development guide for a merged feature to maintain current module counts and statuses. This ensures the DEVELOPMENT_GUIDE.md accurately reflects the latest project state after new features are integrated.

How does managing refactoring history documentation work during feature development?▼

Managing refactoring history documentation works by systematically updating REFACTORING_HISTORY.md during feature development and pull requests. This ensures all refactoring actions are recorded according to project standards for historical tracking.

Do I need to follow specific file naming and content standards for IBL5 guides?▼

Yes, you need to follow specific file naming and content standards for IBL5 guides. Adhering to these standards ensures consistency and completeness across strategic priorities, development guides, and component documentation artifacts.

Related Skills

Explore More Software Engineering Skills→
ResearAIResearAI
3.3k

baseline

Standardize a reference object for quest evaluation with plan and checklist requirements.

Community
Advanced
glideappsglideapps

final-review

Validate code changes against tests, types, lint, and PR metadata before merging.

Official
Advanced
yungwengyungweng
3

gitnexus-refactoring

Analyze code dependencies and automate multi-file symbol updates for safe refactoring.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate