Skip to content
This repository was archived by the owner on Sep 24, 2022. It is now read-only.
This repository was archived by the owner on Sep 24, 2022. It is now read-only.

Chronologue docs: Troubleshooting defect XYZ #17

@valeriahhdez

Description

@valeriahhdez

Summary

"Troubleshooting defect XYZ" is a troubleshooting that provides technicians with an in-depth explanation of how to troubleshoot XYZ.

Research

  • Determine user goals.
  • Determine prerequisites
  • Determine what steps the user has to take.

Writing/Testing

  • Create a new branch.
  • Create a draft.
  • Write a commentary in the document to highlight best practices.
  • Take feedback notes for the template group.
  • Create a PR.

Review

  • Grammatical review.
  • Technical review.

Publication

  • Merge PR to docs.

Resources

Source file: INSERT LINK IF SOURCE FILE ALREADY EXISTS
Template: INSERT LINK FOR THE TEMPLATE. All templates are located in: https://github.com/thegooddocsproject/templates/
Feedback form: INSERT LINK

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions