chore: remove docs plan
This commit is contained in:
Matt Bruce
parent
2500b54bcc
commit
c88b5e34b9
138
AI-Docs-Plan.md
138
AI-Docs-Plan.md
@ -1,138 +0,0 @@
|
|||||||
# AI Documentation Plan
|
|
||||||
|
|
||||||
## Purpose
|
|
||||||
Create a Confluence-ready hierarchy and an initial documentation set that assumes zero prior knowledge. This plan now maps directly to markdown files under a docs folder.
|
|
||||||
|
|
||||||
## Proposed Folder Structure
|
|
||||||
- docs/
|
|
||||||
- ai/
|
|
||||||
- index.md
|
|
||||||
- overview.md
|
|
||||||
- ios.md
|
|
||||||
- android.md
|
|
||||||
- cross-platform.md
|
|
||||||
- skills.md
|
|
||||||
- usage-tokens.md
|
|
||||||
- troubleshooting.md
|
|
||||||
- governance.md
|
|
||||||
|
|
||||||
## Top-Level Hierarchy (Confluence)
|
|
||||||
1. AI Overview
|
|
||||||
2. iOS (Xcode + optional VS Code)
|
|
||||||
3. Android (VS Code)
|
|
||||||
4. Cross-Platform AI Usage
|
|
||||||
5. Skills Library
|
|
||||||
6. Usage and Token Budgeting
|
|
||||||
7. Troubleshooting and FAQ
|
|
||||||
8. Governance, Privacy, and Policy
|
|
||||||
|
|
||||||
## 1) AI Overview
|
|
||||||
- Start Here
|
|
||||||
- What AI is and is not (short definitions)
|
|
||||||
- What problems AI can help with (examples)
|
|
||||||
- What not to use AI for (guardrails)
|
|
||||||
- GitHub Copilot Enterprise
|
|
||||||
- What it is
|
|
||||||
- Access requirements
|
|
||||||
- Account setup steps
|
|
||||||
- Terminology
|
|
||||||
- Copilot
|
|
||||||
- Chat
|
|
||||||
- Agents
|
|
||||||
- Skills
|
|
||||||
- Tokens and usage
|
|
||||||
- Getting Help
|
|
||||||
- Who to contact
|
|
||||||
- Where to report issues
|
|
||||||
|
|
||||||
## 2) iOS (Xcode + optional VS Code)
|
|
||||||
- Setup Path A: Xcode + GitHub Copilot for Xcode
|
|
||||||
- Prerequisites
|
|
||||||
- Install plugin
|
|
||||||
- Sign in and verify
|
|
||||||
- First-use walkthrough
|
|
||||||
- Setup Path B: VS Code + GitHub Copilot extension
|
|
||||||
- When to use VS Code on iOS
|
|
||||||
- Install extension
|
|
||||||
- Sign in and verify
|
|
||||||
- First-use walkthrough
|
|
||||||
- iOS-Specific Guidance
|
|
||||||
- Swift/SwiftUI tips
|
|
||||||
- Common prompt patterns for iOS
|
|
||||||
- iOS Troubleshooting
|
|
||||||
- Login issues
|
|
||||||
- Suggestions not appearing
|
|
||||||
- Network or policy blocks
|
|
||||||
|
|
||||||
## 3) Android (VS Code)
|
|
||||||
- Setup: VS Code + GitHub Copilot extension
|
|
||||||
- Prerequisites
|
|
||||||
- Install extension
|
|
||||||
- Sign in and verify
|
|
||||||
- First-use walkthrough
|
|
||||||
- Android-Specific Guidance
|
|
||||||
- Kotlin/Java tips
|
|
||||||
- Common prompt patterns for Android
|
|
||||||
- Android Troubleshooting
|
|
||||||
- Login issues
|
|
||||||
- Suggestions not appearing
|
|
||||||
- Network or policy blocks
|
|
||||||
|
|
||||||
## 4) Cross-Platform AI Usage
|
|
||||||
- Agents.md
|
|
||||||
- What it is
|
|
||||||
- How to use it (copy/paste examples)
|
|
||||||
- When to use agents vs chat
|
|
||||||
- Prompting Patterns
|
|
||||||
- Asking for refactors
|
|
||||||
- Writing tests
|
|
||||||
- Debugging errors
|
|
||||||
- Explaining unfamiliar code
|
|
||||||
- Connecting Skills
|
|
||||||
- When to use a skill
|
|
||||||
- How to chain multiple skills
|
|
||||||
- How to pass context between steps
|
|
||||||
|
|
||||||
## 5) Skills Library
|
|
||||||
- What skills are
|
|
||||||
- How to download existing skills
|
|
||||||
- How to enable or configure skills
|
|
||||||
- Current Skills (add repo links)
|
|
||||||
- onboarding-cro (link)
|
|
||||||
- revenuecat-ios-integration (link)
|
|
||||||
- find-skills (link)
|
|
||||||
- swiftui-expert-skill (link)
|
|
||||||
- mcp-builder (link)
|
|
||||||
- pdf (link)
|
|
||||||
- skill-creator (link)
|
|
||||||
- template-skill (link)
|
|
||||||
- webapp-testing (link)
|
|
||||||
|
|
||||||
## 6) Usage and Token Budgeting
|
|
||||||
- How tokens are spent (simple model)
|
|
||||||
- Best practices to reduce usage
|
|
||||||
- Use clear, bounded requests
|
|
||||||
- Prefer edits over full rewrites
|
|
||||||
- Reuse context instead of re-sending
|
|
||||||
- Daily and monthly budgeting tips
|
|
||||||
- Red flags that burn tokens quickly
|
|
||||||
- Quick checklist
|
|
||||||
|
|
||||||
## 7) Troubleshooting and FAQ
|
|
||||||
- Setup and login errors
|
|
||||||
- Extension or plugin conflicts
|
|
||||||
- Company network restrictions
|
|
||||||
- Why suggestions are low quality
|
|
||||||
- When to escalate
|
|
||||||
|
|
||||||
## 8) Governance, Privacy, and Policy
|
|
||||||
- What data is allowed
|
|
||||||
- What data is forbidden
|
|
||||||
- Safe prompts and examples
|
|
||||||
- Compliance and audit expectations
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
- Assign owners per section
|
|
||||||
- Link skills to their repos
|
|
||||||
- Add screenshots and short videos
|
|
||||||
- Set review cadence
|
|
||||||
@ -6,7 +6,6 @@ This repo contains the source markdown for a Confluence-ready AI documentation s
|
|||||||
- [AI Docs Index](docs/ai/index.md)
|
- [AI Docs Index](docs/ai/index.md)
|
||||||
- [Agents](Agents.md)
|
- [Agents](Agents.md)
|
||||||
- [PRD](PRD.md)
|
- [PRD](PRD.md)
|
||||||
- [AI Docs Plan](AI-Docs-Plan.md)
|
|
||||||
|
|
||||||
## How to Use
|
## How to Use
|
||||||
1. Start at the [AI Docs Index](docs/ai/index.md).
|
1. Start at the [AI Docs Index](docs/ai/index.md).
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user