keep-ai-ready

Update AGENTS.md and HOWTOAI.md after significant implementation changes.

8|Updated May 16, 2024
One-click install
npx skills add https://github.com/michael-watson/graphql-workbench --skill keep-ai-ready
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: keep-ai-ready
Source: https://github.com/michael-watson/graphql-workbench/tree/main/.claude/skills/keep-ai-ready
Command: npx skills add https://github.com/michael-watson/graphql-workbench --skill keep-ai-ready

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that AI-related documentation within a repository remains up-to-date and reflects the latest implementation patterns and architectural changes, making it easier for AI agents to understand and follow project conventions.

Core Features & Use Cases

  • Documentation Maintenance: Automatically updates key AI documentation files like AGENTS.md and HOWTOAI.md.
  • Pattern Documentation: Captures new coding patterns, conventions, and architectural decisions.
  • Example Generation: Incorporates real-world examples from recent implementations into documentation.
  • Use Case: After a significant feature implementation involving new authentication patterns, this skill can be run to update AGENTS.md with the new pattern and HOWTOAI.md with an example of how to use it, ensuring future AI-assisted development adheres to the new standard.

Quick Start

Run the keep-ai-ready skill to update AI documentation after a major implementation.

Frequently Asked Questions about keep-ai-ready

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

FAQPage Schema
How do I keep AI documentation current after major code changes?

To keep AI documentation current, you analyze completed specs to identify new patterns and architectural decisions, then update repository files like AGENTS.md and HOWTOAI.md so AI agents follow the latest project conventions.

What is AI-ready repository documentation and why do I need it?

AI-ready repository documentation consists of files like AGENTS.md and HOWTOAI.md that provide actionable context. You need it to ensure AI agents understand your coding patterns, conventions, and architecture before generating or modifying code.

When should I update AGENTS.md and HOWTOAI.md files?

You should update AGENTS.md and HOWTOAI.md files after significant feature implementations or architectural changes to capture new conventions and real-world examples, ensuring future AI-assisted development adheres to current standards.

What's the best way to document new coding patterns for AI agents?

The best way to document new coding patterns for AI agents is to analyze recent implementations and extract lessons learned, incorporating real-world examples into your AI documentation files to maintain actionable guidance.

Does keep-ai-ready require any dependencies to maintain repository documentation?

No, keep-ai-ready requires no dependencies to maintain repository documentation. It operates independently to analyze completed specs and update AI documentation files with new architectural patterns and conventions.

Can I use keep-ai-ready for repository management on any codebase?

Yes, you can use keep-ai-ready for repository management on any codebase. It analyzes completed specs and architectural changes to update AI documentation files, ensuring AI agents understand project conventions regardless of stack.