81 lines
2.6 KiB
Markdown
81 lines
2.6 KiB
Markdown
# Product Requirements Document (PRD)
|
|
|
|
## Product
|
|
AI Documentation for Mobile Development
|
|
|
|
## Problem Statement
|
|
Teams need a clear, zero-knowledge onboarding path for AI tools, setup, and usage across iOS and Android.
|
|
|
|
## Goals
|
|
- Provide a structured, searchable AI docs hierarchy.
|
|
- Enable fast setup for Copilot on Xcode and VS Code.
|
|
- Document agents, skills, and token budgeting.
|
|
- Set guardrails for safe AI usage.
|
|
|
|
## Non-Goals
|
|
- Replacing official vendor documentation.
|
|
- Providing legal or security approvals.
|
|
- Enforcing policy compliance.
|
|
|
|
## Target Audience
|
|
- Mobile engineers (iOS and Android).
|
|
- New hires and interns.
|
|
- Tech leads who onboard team members.
|
|
|
|
## User Stories
|
|
- As a new engineer, I can set up Copilot in under 30 minutes.
|
|
- As a lead, I can point people to a single AI docs index.
|
|
- As a contributor, I can add or update skills guidance.
|
|
|
|
## Success Metrics
|
|
- Time-to-setup under 30 minutes for new users.
|
|
- Reduced setup questions in chat or onboarding sessions.
|
|
- Consistent AI usage aligned with policy.
|
|
|
|
## Scope
|
|
- Confluence-ready structure with markdown source.
|
|
- iOS and Android setup guides.
|
|
- Skills inventory and usage guidance.
|
|
- Token usage guidance and troubleshooting.
|
|
|
|
## Content Requirements
|
|
- Assume readers are new to AI.
|
|
- Use step-by-step instructions and plain language.
|
|
- Provide examples for key workflows.
|
|
- Explain chat modes (Ask, Edit, Plan, Agent) with concrete examples.
|
|
|
|
## Definition Of Done (Doc Updates)
|
|
- New markdown files are linked in docs/ai/index.md.
|
|
- Sections include at least one concrete example.
|
|
- Instructions are step-by-step and beginner-friendly.
|
|
- Formatting is clean (no stray diff markers or broken code blocks).
|
|
- Agents.md and README are updated if workflow or structure changes.
|
|
|
|
## Assumptions
|
|
- The org has a Copilot Enterprise subscription.
|
|
- Editors are standard across teams (Xcode and VS Code).
|
|
- Policies for data handling are available elsewhere.
|
|
|
|
## Dependencies
|
|
- GitHub Copilot Enterprise access and provisioning.
|
|
- Editor plugins and extensions are approved for use.
|
|
- A shared location for skills and updates.
|
|
|
|
## Documentation Sync
|
|
When scope, workflows, or structure change, update PRD, README, and Agents together.
|
|
|
|
## Risks and Mitigations
|
|
- Outdated instructions: set a review cadence.
|
|
- Unclear ownership: assign section owners.
|
|
- Overly generic guidance: add platform-specific examples.
|
|
|
|
## Milestones
|
|
- Draft structure and initial content.
|
|
- Review with iOS and Android leads.
|
|
- Publish to Confluence and iterate.
|
|
|
|
## Open Questions
|
|
- Who owns each section and review cadence?
|
|
- Where should skill repo links be hosted?
|
|
- What screenshots and examples are required?
|