Skip to content
KathrynEE edited this page Dec 9, 2019 · 8 revisions

Docathon scheduled for 12/13/2019

Schedule

12/6 - Sync meeting
12/11 - Training, record and post training
12/13 - Day of docathon

Summary

Summary Description
Who Azure DevOps Product team PMs and engineers - Jeff Beehler main point of contact
What Spend a day to address outstanding GitHub issues for the vsts-docs-pr; goal is to close 80% or more issues. Current issue count is 894 (12/4)
Where TBD, Online (Are we reserving any conference rooms for people to work in)
Why GitHub issues identify customer pain points and we want to be customer advocates by addressing these issues.

Actions to take to select an issue to address:

  1. Filter the list of issues by your subject matter expertise and Priority - use Labels to filter (demo in training)
  2. Address the latest issues first working towards the oldest issues
  3. Work on Pri2 issues second and then Pri3 issues, always working from latest to oldest.
  4. Enter a comment in the issue that you are working on the issue to indicate to others that it is being addressed.

Types of issues and how to close

Types of issues How to close Notes
Information is not accurate, needs update Action 1 or 2 If issue requires 30 minutes or more to fix, do 2
Information is incomplete Action 1 or 2 If issue requires 30 minutes or more to fix, do 2
Issue is a product suggestion Action 3
Issue requires support Action 4
Article has a broken link Action 5
Correction suggested invalidates current guidance Action 6

Actions to take to close a GitHub Issue:

  1. Fix the article by providing more information, clarifying information, or other. All articles to be fixed in the azure-devops-docs-pr repo (or for Server Administration, [azure-devops-server-docs-pr repo(https://github.com/MicrosoftDocs/azure-devops-server-docs-pr)). Enter a comment to the issuer that you are addressing the issue and then Close. See Canned comments.
  2. Open a backlog item - doc bug or User Story - to address the issue within the next 3 months (may need a followup meeting to triage these bugs/stories). Enter a comment to the issuer that you've created a backlog item to address the issue, specify the work ID of the backlog item, assign the label backlog-item-created, and then Close the issue.
  3. Refer issuer to Developer Community website (Product feature) and close the issue (canned response)
  4. Refer issuer to Developer Community website (Support ) and close the issue (canned response)
  5. Assign broken-link label and Assign the issue to a content writer to address (KathrynEE, ChComley, juliakm, steved0x)
  6. Close the issue as non-actionable and label as non-actionable. (canned response) Reasons for something being non-actionable: a. The guidance provided is correct b. Issuer doesn't provide sufficient information to take action (e.g., doesn't provide a topic as reference) c. Issue is so old the content has become irrelevant

Items to provide docathoners:

  • Links to Doc Bug and User Story templates
  • Canned responses to use - GitHub actions?

Canned responses

A. Close Issue, Issue Addressed:
Thank you for your feedback. The article reference is being updated to address the issue.
B. Close Issue, Backlog Item Created:
Thank you for your feedback. A backlog item has been created to update the article to address the issue you've raised.
C. Close Issue, Refer to Developer Community, Support Issue:
Thank you for your feedback. We are closing this issue and directing you to seek an answer through our support web site: Developer Community.
D. Close Issue, Refer to Developer Community, New Feature Request:
Thank you for your feedback. We are closing this issue and directing you to file a feature requests through our support web site: Developer Community.
E. Close Issue, Non-actionable:
Thank you for your feedback. We are closing this issue as there is no action to take on our part as the issue addresses content that is no longer relevant.

Clone this wiki locally