Main goals for requestctl documentation improvements:
- Docs should be more audience-focused, so they're more accessible to different types of users (new SRE, active SRE, admin)
- Docs should be more concise and succinct: use writing style and structure focused on optimizing UX for readers under pressure
- Docs should contain updated links to/from relevant resources like playbooks and code repos
This work is broken down into 3 pieces, in order of priority (highest to lowest):
- p0 - Create an outline of a task-focused document that emphasizes examples and contains how-to instructions and a quick reference. Audience: SREs who are using the tool during an outage
- p1 - Create an outline of a conceptual overview and tutorials to help readers learn how to use the tool, understand its purpose, get comfortable with its functionality, and understand the object model. Audience: SREs who are onboarding or new to using the tool.
- p2 - Create an outline of a task-focused document that covers administrative work like submitting patches or performing other tool maintainance tasks. Audience: Engineers/admins who maintain the requestctl tool.