56 lines
1.3 KiB
Markdown
56 lines
1.3 KiB
Markdown
# 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.
|
|
|
|
## Current Docs Location
|
|
- docs/ai/
|
|
|
|
## Confluence Mapping
|
|
The docs under docs/ai map 1:1 to Confluence pages.
|
|
|
|
## 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
|
|
|
|
## Folder Structure (Current)
|
|
- docs/
|
|
- ai/
|
|
- index.md
|
|
- overview.md
|
|
- ios.md
|
|
- android.md
|
|
- cross-platform.md
|
|
- skills.md
|
|
- usage-tokens.md
|
|
- troubleshooting.md
|
|
- governance.md
|
|
- planning/
|
|
- AI-Docs-Plan.md
|
|
|
|
## 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.
|
|
|
|
## 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.
|