Skip to content

Conversation

ChisomUma
Copy link
Contributor

@ChisomUma ChisomUma commented Jan 31, 2025

Proposed changes

Problem: Comprehensive documentation readability audit revealed suboptimal accessibility with a Hemingway app grade level of 9, indicating problems with audience comprehension. Additional analysis identified grammatical and structural inconsistencies across the documentation page that impacted developer experience.

Solution: Executed a complete documentation restructuring initiative involving 1,000+ Markdown lines of technical content. Implemented a systematic two-phase approach: (1) Strategic content separation - isolated code snippets and product-specific terminology to enable focused documentation analysis, and (2) Comprehensive sentence reconstruction - rewrote complex technical explanations while preserving accuracy and technical depth. This method achieved a measurable 22% improvement in readability (from grade level 9 to 7), significantly improving documentation accessibility for diverse technical audiences.

Hemingway-Editor-01-31-2025_08_11_PM

Please focus on (optional): I would love feedback on the writing and areas I could improve upon. Also, I'm open to any changes, updates, and edits to the documentation required of me.

Issue #101

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • I have updated any relevant documentation (README.md and CHANGELOG.md)
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation.

Please refer to our style guide for guidance about placeholder content.

@ChisomUma ChisomUma requested a review from a team as a code owner January 31, 2025 19:55
Copy link

github-actions bot commented Jan 31, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@ChisomUma
Copy link
Contributor Author

I have hereby read the F5 CLA and agree to its terms

@ChisomUma ChisomUma force-pushed the chisomngixopencource branch from 86ab449 to f0ea3eb Compare January 31, 2025 20:17
@mjang mjang self-requested a review January 31, 2025 20:56
@mjang
Copy link
Contributor

mjang commented Jan 31, 2025

@ChisomUma , thanks so much! I hope to get to this early next week.

@mjang
Copy link
Contributor

mjang commented Feb 5, 2025

@ChisomUma , thanks so much for your contribution! The work you've done is immense.

To speed the process, I'd like your permission to incorporate (mostly) standard conventions from our style guide.

  • You'll still be able to see my comments, as well as the changes that I make to your proposed work.
    • I'll be happy to answer any questions that you have to the changes that I add.
    • You're welcome to use our discussion as a learning process.

I would then submit your work for a second review, as we require two reviews before merging any pull request.

@ChisomUma
Copy link
Contributor Author

Hi @mjang thank you very much for getting to my contribution. Yes, you have my permission to incorporate standard conventions from the style guide. I'd be happy to learn from this.

Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The work you've done, @ChisomUma, is fantastic!

I apologize for the large number of comments -- they're primarily related to our style guide at https://github.com/nginx/documentation/blob/main/templates/style-guide.md. It's based on the Microsoft style guide, and I understand if you're not familiar with it.

As the changes I propose are straightforward, with your OK, I'm going to merge these changes directly. You're welcome to ask / object to any of my changes. I'd love to help you get to know NGINX documentation.

I think this process can help improve your skills as a Technical Writer.

Mostly based on the NGINX style guide
@ChisomUma
Copy link
Contributor Author

ChisomUma commented Feb 5, 2025

Hi @mjang , thank you very much! your suggestions are 100% valid, and I am honored to receive these feedbacks from you. Ill ensure to look more into the style guide next time. You have my OK on these changes. If I have further questions, I'll be sure to ping you :)

Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mjang mjang merged commit 0cb7e6f into nginx:main Feb 7, 2025
5 checks passed
@mjang mjang added community and removed in review labels Feb 18, 2025
@ChisomUma ChisomUma changed the title improve readability and grammatical errors docs: implement systematic readability enhancement and grammatical standardization across technical documentation Aug 26, 2025
@ChisomUma ChisomUma changed the title docs: implement systematic readability enhancement and grammatical standardization across technical documentation docs: implement systematic readability improvements and grammatical standardization across technical documentation Aug 26, 2025
@ChisomUma ChisomUma changed the title docs: implement systematic readability improvements and grammatical standardization across technical documentation docs: implement readability improvements and grammatical standardization across technical documentation for developers Sep 14, 2025
@ChisomUma ChisomUma changed the title docs: implement readability improvements and grammatical standardization across technical documentation for developers docs: implement readability improvements and grammatical standardization across developer documentation Sep 14, 2025
@ChisomUma ChisomUma changed the title docs: implement readability improvements and grammatical standardization across developer documentation docs: improved NGINX Plus Deployment Guide: All-Active HA for NGINX Plus on GCP Sep 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants