This project provides a Java-based tool for calculating the Gunning Fog Index of software documentation. The Gunning Fog Index is a readability test that estimates the years of formal education or the minimum age a full-time student needs to understand a text on the first reading. This tool is specifically tailored to analyze the readability of software-related documents, making it an essential utility for technical writers, software developers, and project managers.

• Read text files containing software documentation.
• Calculate the Gunning Fog Index to assess readability.
• Handle various types of software documentation, from user guides to technical API documents.

• Java JDK 8 or higher

1. Clone the repository to your local machine.
2. Navigate to the cloned directory.
3. Compile the Java program.

1. Place your software documentation text files in the docs directory.
2. Run the program with the filename as an argument.
3. The program will output the Gunning Fog Index for the provided document.

Contributions to this project are welcome. To contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/AmazingFeature).
3. Commit your changes (git commit -m 'Add some AmazingFeature').
4. Push to the branch (git push origin feature/AmazingFeature).
5. Open a pull request.

Matheus K. Westphalen - [email protected]

Nicole Edoziem - [email protected]

Project Link: https://github.com/mwestphalen/gunning-fog-index-calculator