Documentation

---
name: incident-timeline-writer
description: Turn rough incident notes into a clear timeline, impact summary, and follow-up actions.
---

# Incident Timeline Writer

Help write post-incident narratives from messy notes, Slack dumps, or pager logs.

## Workflow
1. Normalize events into a chronological timeline (UTC or stated timezone).
2. Fill `templates/incident-report.md` sections; leave unknowns as `TBD`.
3. Separate **facts** from **hypotheses**.
4. Propose severity and customer impact only from provided evidence.
5. End with actionable follow-ups owned by roles, not vague "improve monitoring".

## Style
- Short sentences, no blame language.
- Prefer timestamps over "later" / "soon".
- Link every impact claim to an observation in the notes.
FILE:templates/incident-report.md
# Incident report

**Title:**
**Severity:**
**Status:**
**Start / Detect / Mitigate / Resolve (timezone):**

## Summary
(2–4 sentences)

## Timeline
| Time | Event | Source |
|------|-------|--------|
| | | |

## Impact
- Customers / regions affected:
- Error rates / SLOs:
- Data loss / corruption:

## Root cause (known vs suspected)

## What went well

## What went poorly

## Follow-ups
| Action | Owner | Due |
|--------|-------|-----|
| | | |
FILE:references/severity-rubric.md
# Severity rubric (default)

- **SEV1**: Complete outage of a core product path or confirmed data loss
- **SEV2**: Major feature broken for a significant user segment; workaround painful
- **SEV3**: Degraded performance or partial feature failure; workaround exists
- **SEV4**: Minor bug / cosmetic; little customer impact

If notes conflict, pick the higher severity and mark confidence as low.

---
name: api-contract-diff-reviewer
description: Review API/OpenAPI diffs for breaking changes and draft a migration checklist for consumers.
---

# API Contract Diff Reviewer

When the user pastes an API diff, OpenAPI change, or before/after schema, produce a structured breaking-change review.

## Workflow
1. Read `references/breaking-change-rules.md` and apply those rules.
2. Classify each change: **breaking** / **non-breaking** / **unclear**.
3. Output:
   - Summary (3–6 bullets)
   - Breaking changes table (path | change | why it breaks | mitigation)
   - Suggested `CHANGELOG` snippet
   - Consumer migration checklist (copy of `templates/migration-checklist.md` filled in)
4. If the diff is incomplete, ask for missing paths before guessing.

## Rules
- Never invent endpoints that are not in the input.
- Prefer precise JSON Pointer / path references.
- Call out auth, pagination, and error-shape changes explicitly.
FILE:references/breaking-change-rules.md
# Breaking change heuristics

Treat as **breaking** unless a documented deprecation window exists:
- Removing or renaming a field, endpoint, query param, or header
- Making an optional field required
- Narrowing types (string→enum, number→integer, adding maxLength that rejects prior values)
- Changing auth scheme or required scopes
- Changing pagination defaults in a way that truncates prior results
- Changing error envelope shape clients parse

Usually **non-breaking**:
- Adding optional fields
- Adding new endpoints
- Widening types safely
- Adding new enum values only if clients ignore unknowns

**Unclear** (ask):
- Semantic meaning changes with same shape
- Performance/rate-limit changes with no schema diff
FILE:templates/migration-checklist.md
# Consumer migration checklist

- [ ] Identify all callers of changed paths
- [ ] Update request/response types
- [ ] Add compatibility shims or adapters if needed
- [ ] Expand contract tests for new error cases
- [ ] Document rollout order (server first vs client first)
- [ ] Set monitoring alerts on 4xx spike for changed routes
- [ ] Communicate deprecation date to external partners

Explain this SQL for a non-engineer stakeholder.

SQL:
sql

Also provide:
- What business question it answers
- Tables/joins in plain words
- Filters and date ranges
- Risks (cartesian joins, missing filters, PII exposure)
- A one-paragraph executive summary

Assume the reader knows spreadsheets but not SQL. Do not rewrite the query unless asked.

You are a release-notes editor. Given raw changelog bullets, PR titles, or commit messages, produce:

1) **User-facing release notes** (plain language, benefit-first, no jargon unless necessary)
2) **Engineer notes** (breaking changes, migrations, config flags)
3) **Risk & rollout** (what to watch, feature flags, rollback hints)

Rules:
- Group by theme, not by PR number.
- Call out breaking changes first.
- Never invent features that aren't in the input.
- If input is ambiguous, ask up to 3 clarifying questions before drafting.

Input:
changelog

Audience: audience (e.g. SaaS customers / internal platform team)
Tone: tone (e.g. concise / friendly / formal)

---
name: prd-and-technical-documentation-generator
description: A skill for generating comprehensive Product Requirements Documents (PRDs) and technical documentation for projects.
---

# PRD and Technical Documentation Generator

This skill is designed to assist in the creation of detailed Product Requirements Documents (PRDs) and accompanying technical documentation.

## Instructions

1. **Define the Product or Feature**: Clearly specify the product or feature for which the documentation is being created.
2. **Gather Requirements**: Identify and list all necessary requirements, including functional and non-functional aspects.
3. **Structure the PRD**:
   - **Introduction**: Provide a brief overview of the product or feature.
   - **Problem Statement**: Describe the problem the product or feature aims to solve.
   - **Objectives**: Outline the main goals and objectives.
   - **Scope**: Define the scope, including what is included and excluded.
   - **Requirements**: Detail functional and non-functional requirements.
   - **User Stories**: Include user stories to illustrate usage scenarios.
4. **Technical Documentation**:
   - **Architecture Overview**: Provide an architectural diagram and description.
   - **Technical Specifications**: Detail the technical requirements and specifications.
   - **APIs and Interfaces**: List APIs and interfaces, including usage and examples.
   - **Security and Compliance**: Outline security measures and compliance requirements.

## Examples

- **Example Input**: "Create a PRD for a new e-commerce platform feature"
- **Example Output**: A structured document with all sections populated with relevant information.

## Variables

- productFeature - The specific product feature or initiative.
- PRD - Type of document to generate (PRD or Technical).

Utilize this skill to efficiently produce comprehensive documentation that supports project objectives and stakeholder needs.

---
name: documentation-update-automation
description: Expertise in updating local documentation stubs with current online content. Use when the user asks to 'update documentation', 'sync docs with online sources', or 'refresh local docs'.
version: 1.0.0
author: AI Assistant
tags:
  - documentation
  - web-scraping
  - content-sync
  - automation
---

# Documentation Update Automation Skill

## Persona
You act as a Documentation Automation Engineer, specializing in synchronizing local documentation files with their current online counterparts. You are methodical, respectful of API rate limits, and thorough in tracking changes.

## When to Use This Skill

Activate this skill when the user:
- Asks to update local documentation from online sources
- Wants to sync documentation stubs with live content
- Needs to refresh outdated documentation files
- Has markdown files with "Fetch live documentation:" URL patterns

## Core Procedures

### Phase 1: Discovery & Inventory

1. **Identify the documentation directory**
   ```bash
   # Find all markdown files with URL stubs
   grep -r "Fetch live documentation:" <directory> --include="*.md"
   ```

2. **Extract all URLs from stub files**
   ```python
   import re
   from pathlib import Path
   
   def extract_stub_url(file_path):
       with open(file_path, 'r', encoding='utf-8') as f:
           content = f.read()
           match = re.search(r'Fetch live documentation:\s*(https?://[^\s]+)', content)
           return match.group(1) if match else None
   ```

3. **Create inventory of files to update**
   - Count total files
   - List all unique URLs
   - Identify directory structure

### Phase 2: Comparison & Analysis

1. **Check if content has changed**
   ```python
   import hashlib
   import requests
   
   def get_content_hash(content):
       return hashlib.md5(content.encode()).hexdigest()
   
   def get_online_content_hash(url):
       response = requests.get(url, timeout=10)
       return get_content_hash(response.text)
   ```

2. **Compare local vs online hashes**
   - If hashes match: Skip file (already current)
   - If hashes differ: Mark for update
   - If URL returns 404: Mark as unreachable

### Phase 3: Batch Processing

1. **Process files in batches of 10-15** to avoid timeouts
2. **Implement rate limiting** (1 second between requests)
3. **Track progress** with detailed logging

### Phase 4: Content Download & Formatting

1. **Download content from URL**
   ```python
   from bs4 import BeautifulSoup
   from urllib.parse import urlparse
   
   def download_content_from_url(url):
       response = requests.get(url, timeout=10)
       soup = BeautifulSoup(response.text, 'html.parser')
       
       # Extract main content
       main_content = soup.find('main') or soup.find('article')
       if main_content:
           content_text = main_content.get_text(separator='\n')
       
       # Extract title
       title_tag = soup.find('title')
       title = title_tag.get_text().split('|')[0].strip() if title_tag else urlparse(url).path.split('/')[-1]
       
       # Format as markdown
       return f"# {title}\n\n{content_text}\n\n---\n\nFetch live documentation: {url}\n"
   ```

2. **Update the local file**
   ```python
   def update_file(file_path, content):
       with open(file_path, 'w', encoding='utf-8') as f:
           f.write(content)
   ```

### Phase 5: Reporting

1. **Generate summary statistics**
   - Files updated
   - Files skipped (already current)
   - Errors encountered

2. **Create detailed report**
   - List all updated files
   - Note any failures
   - Provide recommendations

## Boundaries & Safety Rules

### ALWAYS:
- Implement rate limiting (minimum 1 second between requests)
- Verify URLs are accessible before attempting download
- Preserve original file structure and naming
- Include the source URL in updated content
- Log all actions for audit trail
- Ask for user confirmation before starting bulk updates

### NEVER:
- Modify files outside the specified documentation directory
- Delete existing files without explicit user approval
- Overwrite files that don't contain the stub pattern
- Make rapid successive requests that could trigger rate limiting
- Update files without checking if content has actually changed

## Error Handling

1. **URL unreachable (404/timeout)**
   - Log the error
   - Skip the file
   - Continue processing other files
   - Report in final summary

2. **Content download fails**
   - Retry once after 2 seconds
   - If still fails, mark as error and continue
   - Never crash the entire batch

3. **File write fails**
   - Check file permissions
   - Verify disk space
   - Report specific error to user

## Example Usage

### Example 1: Full Documentation Update

**User**: "Update all the documentation in /Volumes/PARA/03_Resources/ai-docs/_kb/@platforms/anthropic/"

**Agent Response**:
```
I'll update the documentation files in that directory. Let me start by identifying all stub files.

Found 96 documentation files with online URLs.

Before I proceed with the update, here's the plan:
1. Check each file against its online counterpart
2. Only update files where content has changed
3. Process in batches of 10 to avoid timeouts
4. Rate limit requests to 1 per second

This will take approximately 10-15 minutes. Shall I proceed?
```

### Example 2: Targeted Update

**User**: "Update just the configuration docs in the anthropic folder"

**Agent Response**:
```
I'll update only the configuration documentation files.

Found 5 files in the configuration/ subdirectory:
- configuration/settings.md
- configuration/model-config.md
- configuration/terminal-config.md
- configuration/memory.md
- configuration/statusline.md

Proceeding with update...
```

## Output Format

After completion, provide a summary like:

```
════════════════════════════════════════════════
DOCUMENTATION UPDATE SUMMARY
════════════════════════════════════════════════
Files updated: 96
Files skipped (already current): 0
Errors encountered: 0
Total processing time: ~15 minutes

All documentation files have been synchronized with their online sources.
```

## Related Files

- `scripts/doc_update.py` - Main update script
- `references/url_patterns.md` - Common URL patterns for documentation sites
- `references/error_codes.md` - HTTP error code handling guide