Signed-off-by: Matt Bruce <matt.bruce1@toyota.com>
This commit is contained in:
parent
5d7ff301bb
commit
a5da413706
3
PRD.md
3
PRD.md
@ -48,6 +48,9 @@ Teams need a clear, zero-knowledge onboarding path for AI tools, setup, and usag
|
|||||||
- Editor plugins and extensions are approved for use.
|
- Editor plugins and extensions are approved for use.
|
||||||
- A shared location for skills and updates.
|
- A shared location for skills and updates.
|
||||||
|
|
||||||
|
## Documentation Sync
|
||||||
|
When scope, workflows, or structure change, update PRD, README, and Agents together.
|
||||||
|
|
||||||
## Risks and Mitigations
|
## Risks and Mitigations
|
||||||
- Outdated instructions: set a review cadence.
|
- Outdated instructions: set a review cadence.
|
||||||
- Unclear ownership: assign section owners.
|
- Unclear ownership: assign section owners.
|
||||||
|
|||||||
@ -6,6 +6,7 @@ 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](docs/planning/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).
|
||||||
@ -16,6 +17,7 @@ This repo contains the source markdown for a Confluence-ready AI documentation s
|
|||||||
- Edit files in docs/ai.
|
- Edit files in docs/ai.
|
||||||
- Keep sections short and scannable.
|
- Keep sections short and scannable.
|
||||||
- Avoid vendor-specific step details that change frequently.
|
- Avoid vendor-specific step details that change frequently.
|
||||||
|
- Keep Agents, PRD, and README in sync when scope or structure changes.
|
||||||
|
|
||||||
## Publish to Confluence
|
## Publish to Confluence
|
||||||
1. Copy the page content from each markdown file.
|
1. Copy the page content from each markdown file.
|
||||||
|
|||||||
50
docs/planning/AI-Docs-Plan.md
Normal file
50
docs/planning/AI-Docs-Plan.md
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
# 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.
|
||||||
|
|
||||||
|
## 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.
|
||||||
Loading…
Reference in New Issue
Block a user