--- name: blueprints-maintenance-fc0fff84f5a3 user-invocable: false description: Use after modifying existing systems to update blueprint documentation. Read blueprints before changes, update after. Prevents documentation drift. allowed-tools: [Read, Write, Edit, Grep, Glob] --- # Maintaining Technical Blueprints ## The Sync Problem Documentation drifts from implementation when: - Code changes without doc updates - New features added without documentation - Deprecated features remain documented - Behavior changes aren't reflected ## Verification Process ### Before Making Changes 1. **Find relevant blueprints**: ``` # Search for blueprints related to your system Grep("auth", path: "blueprints/", output_mode: "files_with_matches") # Read the blueprint to understand current documentation Read("blueprints/authentication.md") ``` 2. **Note what documentation exists**: - Overview accurate? - API documentation complete? - Behavior described correctly? 3. **Plan documentation updates** alongside code changes ### After Making Changes 1. **Re-read the blueprint** to verify accuracy: ``` Read("blueprints/authentication.md") ``` 2. **Verify each section**: - Does Overview still describe the purpose? - Are all public APIs documented? - Is behavior description accurate? - Are file paths still correct? 3. **Update the blueprint**: ``` # Read current content, modify as needed, write back Write("blueprints/authentication.md", updated_content_with_frontmatter) ``` 4. **Remove stale content** - outdated docs mislead ## Types of Updates ### Adding New Features When adding functionality: 1. Update the Overview if scope expanded 2. Add new API documentation 3. Document new behavior 4. Update Related Systems if new integrations 5. Add to Files section if new files created ### Modifying Existing Features When changing behavior: 1. Update behavior descriptions 2. Revise API documentation if signatures changed 3. Update examples if usage changed 4. Check related blueprints for impact ### Removing Features When deprecating or removing: 1. Remove API documentation 2. Remove from behavior section 3. Update Overview if scope reduced 4. Consider keeping a "Removed" or "History" note if the change is significant ### Refactoring When restructuring without behavior changes: 1. Update Files section with new paths 2. Update Architecture if structure changed 3. Verify examples still work 4. API documentation usually unchanged ## Documentation Debt ### Recognizing Debt Signs blueprints need attention: - File paths that don't exist - Functions that aren't in the codebase - Behavior that doesn't match reality - Missing documentation for visible features ### Paying Down Debt Prioritize by impact: 1. **Critical**: Public APIs with wrong docs 2. **High**: Core systems undocumented 3. **Medium**: Internal systems outdated 4. **Low**: Minor inaccuracies ## Verification Checklist When reviewing blueprints: ```markdown ## Verification Checklist - [ ] Overview matches current purpose - [ ] All public APIs documented - [ ] API signatures accurate - [ ] Examples execute correctly - [ ] Behavior matches implementation - [ ] File paths exist - [ ] No removed features documented - [ ] Related systems links work - [ ] No duplicate content with other blueprints ``` ## Keeping Blueprints Fresh ### During Development - Treat docs as part of the feature - Update blueprint in same commit as code - Review blueprint changes in code review ### Regular Maintenance - Periodically audit blueprints vs code - Use `/blueprints` command to regenerate - Remove orphaned blueprint files ### Tooling Support The blueprints hooks automatically: - Remind you to check docs (UserPromptSubmit) - Verify docs match changes (Stop hook) ## Anti-Patterns ### Don't - Leave TODO comments in blueprints indefinitely - Copy implementation details that will change - Document external libraries (link instead) - Keep deprecated feature docs "for reference" ### Do - Delete stale content immediately - Update atomically with code - Cross-reference rather than duplicate - Keep examples minimal but complete --- Source attribution: TheBushidoCollective Original project: https://github.com/TheBushidoCollective/han/blob/19caa51d5fd144ef6b2764f2332f4c856aa5d1af/plugins/tools/blueprints/skills/blueprints-maintenance/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice # Functional Source License, Version 1.1, ALv2 Future License ## Abbreviation FSL-1.1-ALv2 ## Notice Copyright 2025 The Bushido Collective ## Terms and Conditions ### Licensor ("We") The party offering the Software under these Terms and Conditions. ### The Software The "Software" is each version of the software that we make available under these Terms and Conditions, as indicated by our inclusion of these Terms and Conditions with the Software. ### License Grant Subject to your compliance with this License Grant and the Patents, Redistribution and Trademark clauses below, we hereby grant you the right to use, copy, modify, create derivative works, publicly perform, publicly display and redistribute the Software for any Permitted Purpose identified below. ### Permitted Purpose A Permitted Purpose is any purpose other than a Competing Use. A Competing Use means making the Software available to others in a commercial product or service that: 1. substitutes for the Software; 2. substitutes for any other product or service we offer using the Software that exists as of the date we make the Software available; or 3. offers the same or substantially similar functionality as the Software. Permitted Purposes specifically include using the Software: 1. for your internal use and access; 2. for non-commercial education; 3. for non-commercial research; and 4. in connection with professional services that you provide to a licensee using the Software in accordance with these Terms and Conditions. ### Patents To the extent your use for a Permitted Purpose would necessarily infringe our patents, the license grant above includes a license under our patents. If you make a claim against any party that the Software infringes or contributes to the infringement of any patent, then your patent license to the Software ends immediately. ### Redistribution The Terms and Conditions apply to all copies, modifications and derivatives of the Software. If you redistribute any copies, modifications or derivatives of the Software, you must include a copy of or a link to these Terms and Conditions and not remove any copyright notices provided in or with the Software. ### Disclaimer THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT. IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE. ### Trademarks Except for displaying the License Details and identifying us as the origin of the Software, you have no right under these Terms and Conditions to use our trademarks, trade names, service marks or product names. ## Grant of Future License We hereby irrevocably grant you an additional license to use the Software under the Apache License, Version 2.0 that is effective on the second anniversary of the date we make the Software available. On or after that date, you may use the Software under the Apache License, Version 2.0, in which case the following will apply: Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: TheBushidoCollective Original project: https://github.com/TheBushidoCollective/han/blob/19caa51d5fd144ef6b2764f2332f4c856aa5d1af/plugins/tools/blueprints/skills/blueprints-maintenance/SKILL.md Attribution basis: Source repository record Fields of work: Content & Media, Development & Engineering, Product Management Roles: DevOps / SRE, Product Manager, Technical Writer Specialties: Specialty not specified Tools: Edit, Glob, Grep, Read, Write Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 3733b57a7ad7b6fc097e19926284c012188c6045d210c824ae61f610cc8d639c