Skip to content

Adds documentation audit report - #258

Open
jjsilva4 wants to merge 1 commit into
mainfrom
i-need-your-help-performing
Open

Adds documentation audit report#258
jjsilva4 wants to merge 1 commit into
mainfrom
i-need-your-help-performing

Conversation

@jjsilva4

Copy link
Copy Markdown
Contributor

Adds a comprehensive audit report outlining 19 distinct style, content, and rendering issues found across the documentation. This report serves as a detailed roadmap for improving the GitKraken Desktop documentation.

The audit categorizes issues by priority and type:

  • Tier 1: Content/Rendering Bugs: Identifies broken HTML, malformed Markdown, incorrect internal links, and misplaced content blocks that negatively impact content rendering and accuracy.
  • Tier 2: Repo-wide Style & Consistency: Details systemic violations of the Google Developer Documentation Style Guide, including missing image alt text, inconsistent heading capitalization and hierarchy, non-standard UI element markup, inappropriate use of "will" and "please", non-descriptive link text, inconsistent product naming, and formatting issues in lists and numbers.
  • Tier 3: Cleanup & Verification: Flags numerous typos, grammar errors, and unverified system requirements that require review and correction.
  • Tier 4: Structural & Organizational Issues: Notes broken image references, missing language tags in code blocks, absent frontmatter in key files, and other content organization inconsistencies.

Each issue includes detailed descriptions, concrete examples, and precise fix instructions, making it actionable for subsequent documentation improvement efforts. This initiative aims to enhance documentation clarity, accuracy, accessibility, and maintainability across the repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants