Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[2024 Q4 Audit] [Review and update the focus and scope sections across all audit reports] #1177

Open
krofax opened this issue Dec 12, 2024 · 1 comment
Labels
docs-audit-2024-Q4 OP Labs documentation audit op-labs Generally assigned for OP Labs employees. Please ask before you take on this issue.

Comments

@krofax
Copy link
Collaborator

krofax commented Dec 12, 2024

Description of the updates required

Review and update the focus and scope sections across all audit reports

Acceptance criteria

Resources

Action items

Github issue label criteria

Choose the appropriate github issue labels for each page.

Priority
  • p-on-hold: (Defer) Tasks that are currently not actionable due to various reasons like waiting for external inputs, dependencies, or resource constraints. These are reviewed periodically to decide if they can be moved to a more active status.
  • p-low: (Nice to do) Tasks that have minimal impact on core operations and no immediate deadlines. These tasks are often more about quality of life improvements rather than essential needs.
  • p-medium: (Could do) Tasks that need to be done but are less critical than high-priority tasks. These often improve processes or efficiency but can be postponed if necessary without immediate severe repercussions.
  • p-high: (Should do) Important tasks that contribute significantly to long-term goals but may not have an immediate deadline. Delaying these tasks could have considerable negative effects but are not as immediate as critical tasks.
  • p-critical: Tasks that have immediate deadlines or significant consequences if not completed on time. These are non-negotiable and often linked to core business functions or legal requirements.
T-shirt size
  • s-XS: (< 1 day) Very simple tasks that require minimal time and effort.
  • s-S: (few days) Tasks that are straightforward but require a bit more time to complete.
  • s-M: (1-2 weeks) Tasks that involve a moderate level of complexity and collaboration.
  • s-L: (several weeks) Complex tasks that require significant time investment and coordination across multiple teams.
  • s-XL: (> 1 month) Very large and complex projects that involve extensive planning, execution, and testing.
Content evaluation - `a-delete`: don't need this page - `a-duplicate`: some content lives elsewhere - `a-minor`: needs small revisions - `a-moderate`: needs moderate revisions - `a-critical`: needs a lot of work

MDX Metadata format

We will be adding better metadata to the header of each page.
If I was actively searching for this page on google and this description was the search result, would I know it's the correct page?
Parse the component and feature tags to add.

---
title: "Your Title Here"
tags: ["tag1", "tag2"]
description: "A short description of the content."
---
@krofax krofax added docs-audit-2024-Q4 OP Labs documentation audit op-labs Generally assigned for OP Labs employees. Please ask before you take on this issue. labels Dec 12, 2024
@krofax
Copy link
Collaborator Author

krofax commented Dec 12, 2024

@sbvegan I have created an issue to address the focus and scope

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-audit-2024-Q4 OP Labs documentation audit op-labs Generally assigned for OP Labs employees. Please ask before you take on this issue.
Projects
None yet
Development

No branches or pull requests

1 participant