1.5 KiB
1.5 KiB
AI Documentation Plan
Purpose
Keep the planning view of the docs hierarchy, scope, and future work. This is a planning artifact, not the published content.
Audience And Tone
- Assume readers are new to AI.
- Use step-by-step instructions.
- Provide at least one example per major section.
- Explain chat modes (Ask, Edit, Plan, Agent) in plain language with examples.
Current Docs Location
- docs/ai/
Confluence Mapping
The docs under docs/ai map 1:1 to Confluence pages.
Top-Level Hierarchy (Confluence)
- AI Overview
- iOS (Xcode + optional VS Code)
- Android (VS Code)
- Cross-Platform AI Usage
- iOS MCP (XcodeBuildMCP)
- Skills Library
- Usage and Token Budgeting
- Troubleshooting and FAQ
- Governance, Privacy, and Policy
Folder Structure (Current)
- docs/
- ai/
- index.md
- overview.md
- ios.md
- ios-xcodebuildmcp.md
- android.md
- cross-platform.md
- skills.md
- usage-tokens.md
- troubleshooting.md
- governance.md
- planning/
- AI-Docs-Plan.md
- ai/
Open Items
- Add repo links for each skill in the Skills Library.
- Add screenshots for setup flows.
- Define section owners and review cadence.
- Add platform-specific prompt examples.
- Identify approved Android MCP tools and add details.
Risks
- Docs drift as tools and plugins update.
- Unclear ownership leads to stale content.
Mitigations
- Review cadence every quarter.
- Assign owners per section.
- Keep setup steps high level; link to vendor docs when needed.