XIP Writing (XerahS Improvement Proposals)

Write and structure XerahS Improvement Proposals with standardized templates and naming rules.

309|15|Updated Dec 29, 2025
One-click install
npx skills add https://github.com/ShareX/XerahS --skill xip-writing-xerahs-improvement-proposals
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: XIP Writing (XerahS Improvement Proposals)
Source: https://github.com/ShareX/XerahS/tree/main/.ai/skills/xip-writing
Command: npx skills add https://github.com/ShareX/XerahS --skill xip-writing-xerahs-improvement-proposals

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

XIP Writing helps teams craft XerahS Improvement Proposals that are actionable, well-structured, and aligned with project architecture.

Core Features & Use Cases

  • Provides a header template and naming conventions to standardize XIP creation.
  • Guides required sections (Overview, Prerequisites, Implementation Phases, Non-Negotiable Rules, Deliverables, Affected Components, Architecture Summary) to ensure clarity and traceability.
  • Supports the GitHub-based workflow by explaining the xip-sync process and how to link issues as the source of truth.

Quick Start

Create a new XIP on GitHub following the XIP naming convention and header template, then run the xip-sync tool to update the local tasks backup.

Frequently Asked Questions about XIP Writing (XerahS Improvement Proposals)

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

FAQPage Schema
How do I structure an improvement proposal for a software architecture change?

To structure an improvement proposal, use a standardized template with required sections like Overview, Prerequisites, Implementation Phases, Non-Negotiable Rules, Deliverables, Affected Components, and Architecture Summary to ensure clarity and traceability across the project.

What is the xip-sync process for GitHub issues?

The xip-sync process updates local task backups by linking GitHub issues as the source of truth. It enforces the GitHub-based workflow, ensuring that improvement proposals remain consistent and traceable from their initial draft through final implementation.

Do I need a specific design doc template for cross-platform feature proposals?

Cross-platform feature proposals require a standardized design doc template that defines header conventions and required sections. Enforcing these structural rules ensures that architecture changes and feature implementations remain actionable and aligned across all platforms.

Can I use GitHub issues as the source of truth for design docs?

Yes, GitHub issues serve as the source of truth for design docs by linking the proposal to the repository. Running the xip-sync tool after creating the issue updates the local tasks backup, maintaining consistency between the design doc and project tracking.

What are the required sections for a project improvement proposal?

Required sections for a project improvement proposal include Overview, Prerequisites, Implementation Phases, Non-Negotiable Rules, Deliverables, Affected Components, and Architecture Summary. These sections enforce consistency and guide the proposal from initial draft to final delivery.

Why does my improvement proposal draft lack traceability?

An improvement proposal draft lacks traceability when it misses standardized header templates, naming conventions, or required sections like Architecture Summary and Affected Components. Applying these conventions and linking GitHub issues ensures full traceability throughout the workflow.