-
Notifications
You must be signed in to change notification settings - Fork 49
Closed
5 / 55 of 5 issues completed
Copy link
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationonboardingplanuser-experience
Description
Overview
This tracking issue covers critical documentation improvements identified through fresh user perspective testing. The analysis revealed that while the documentation has excellent visual design, it assumes too much prior knowledge and lacks foundational explanations.
Source: Discussion #5738
Key Findings
Top 3 Blocking Issues:
- No clear explanation of what "agentic" means
- Compilation concept introduced too late
- Prerequisites don't explain "why"
Planned Tasks
This work is broken into 5 focused tasks addressing the most critical issues:
- Add conceptual foundation to home page - Define core concepts upfront
- Improve Quick Start prerequisites explanation - Add context for each requirement
- Fix Step 3 completion and PAT guidance - Complete instructions and add screenshots
- Add early compilation explanation - Explain compilation before introducing commands
- Create glossary and jargon definitions - Define technical terms throughout docs
Success Criteria
- New users can understand what agentic workflows are before installation
- Prerequisites section explains WHY each item is needed
- Quick Start guide is complete and includes visual guidance
- Compilation concept is clear from the beginning
- Technical jargon is defined inline or via tooltips
Notes
This addresses the "Quick Wins" category from the testing report - changes that help new users immediately with high impact and reasonable effort.
Medium and long-term improvements from the report can be addressed in future iterations based on user feedback.
AI generated by Plan Command for discussion #5738
Reactions are currently unavailable
Sub-issues
Metadata
Metadata
Assignees
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationonboardingplanuser-experience