48 lines
1.6 KiB
Markdown
48 lines
1.6 KiB
Markdown
# AI Documentation Project
|
|
|
|
This repo contains the source markdown for a Confluence-ready AI documentation set for mobile development. It is designed to be beginner-friendly and easy to keep current.
|
|
|
|
## Audience
|
|
These docs assume the reader is new to AI. Be explicit, explain terms, and include examples where possible.
|
|
|
|
## Structure
|
|
- [AI Docs Index](docs/ai/index.md)
|
|
- [Agents](Agents.md)
|
|
- [PRD](PRD.md)
|
|
- [AI Docs Plan](docs/planning/AI-Docs-Plan.md)
|
|
|
|
## How to Use
|
|
1. Start at the [AI Docs Index](docs/ai/index.md).
|
|
2. Read the overview to learn chat modes (Ask, Edit, Plan, Agent).
|
|
3. Follow the iOS or Android setup guide.
|
|
4. Review skills and token usage guidance.
|
|
|
|
When a new chat starts, the assistant should read Agents.md and state the repo purpose at a high level before proceeding.
|
|
|
|
## Local Workflow
|
|
- Edit files in docs/ai.
|
|
- Keep sections short but very detailed and scannable.
|
|
- Avoid vendor-specific step details that change frequently.
|
|
- Keep Agents, PRD, and README in sync when scope or structure changes.
|
|
|
|
## Publish to Confluence
|
|
1. Copy the page content from each markdown file.
|
|
2. Preserve the hierarchy shown in docs/ai/index.md.
|
|
3. Add screenshots or short videos where helpful.
|
|
|
|
## Contributing
|
|
- Keep content short, direct, and beginner-friendly.
|
|
- Add platform-specific examples when possible.
|
|
- Update the Skills Library with repo links.
|
|
|
|
### Example Change
|
|
Example prompt:
|
|
```text
|
|
Add a new skill link to docs/ai/skills.md and include a 2-sentence description.
|
|
```
|
|
|
|
## Next Steps
|
|
- Add screenshots and short walkthrough videos.
|
|
- Assign owners per section.
|
|
- Publish to Confluence.
|