Update README.md

README.md

@@ -9,110 +9,205 @@ app_file: app.py
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
-
-# Document Checker Tool
-
-## Overview
-This tool helps review and validate Federal Aviation Administration (FAA) documents for compliance with formatting rules and style guidelines. It's designed to catch common errors and inconsistencies that might occur in regulatory documents, making the review process faster and more accurate.
-
-## What Does It Do?
-The tool reads Microsoft Word (docx) documents and performs a comprehensive set of checks to ensure they follow FAA documentation standards. Think of it as a specialized proofreader that knows all the specific rules for FAA documents.
-
-## Document Types Supported
-- Advisory Circulars (both Short and Long templates)
-- Airworthiness Criteria
-- Deviation Memos
-- Exemptions
-- Federal Register Notices
-- Handbooks/Manuals
-- Orders
-- Policy Statements
-- Rules
-- Special Conditions
-- Technical Standard Orders
-- Other document types
-
-## What Does It Check For?
-
-### 1. Required Headings
-- Verifies that all required section headings are present
-- Different document types have different required headings
-- For example, Advisory Circulars (AC) must have sections like "PURPOSE.", "APPLICABILITY.", etc.
-
-### 2. Acronym Usage
-- Checks if all acronyms are properly defined at their first use
-- Example: "Federal Aviation Administration (FAA)" must appear before using just "FAA"
-- Identifies any undefined acronyms in the document
-
-### 3. Legal Terminology
-- Ensures proper formatting of legal references
-- Checks for correct usage of terms like:
-  - "U.S.C." instead of "USC"
-  - "Title 14" instead of "title 14" when used in body text. Use "Title 14" when begins a sentence.
-  - "CFR part" instead of "CFR Part" when used in body text.
-- Verifies proper use of "the FAA" instead of "We" or "we"
-
-### 4. Table and Figure Formatting
-- Validates table captions (e.g., for ACs, "Table 1-2" or "Table C-1")
-- Checks figure captions (e.g., for ACs, "Figure 1-2" or "Figure C-1")
-- Ensures proper references to tables and figures within the text
-
-### 5. Document Title Styling
-- Checks if document titles are properly formatted based on document type
-- Some documents require italics, others require quotation marks
-- Ensures consistent styling throughout the document
-
-### 6. Grammar and Formatting
-- Catches double periods at the end of sentences
-- Checks for proper spacing:
-  - Between document type and number (e.g., "AC 20-114")
-  - Around section symbols (e.g., "§ 25.301")
-  - Around part numbers (e.g., "Part 25")
-  - In paragraph indications (e.g., "(a)", "(1)")
-- Identifies double spaces between words
-
-### 7. Consistency Checks
-- Verifies that abbreviations are used consistently after being defined
-- Ensures dates are in the correct format (e.g., "January 1, 2024" instead of "1/1/24" or "1 January 2024")
-- Identifies placeholder text that needs to be replaced (e.g., "TBD", "To be determined")
-
-## How to Use the Tool
-
-1. Run the program
-2. When prompted, either:
-   - Press Enter to use the default document path
-   - Type in the full path to your Word document
-
-3. Select your document type from the numbered list
-
-4. If you're checking an Advisory Circular, select the template type:
-   - Short AC template
-   - Long AC template
-
-5. The tool will process your document and create a file called "check_complete.md" with the results
-
-## Understanding the Results
-
-The results file ("check_complete.md") will show:
-- ✅ Passed checks
-- ❌ Items that need attention
-- Specific examples of what needs to be fixed
-- Suggestions for corrections
-
-## Important Notes
-
-- The tool doesn't make any changes to your original document
-- It's designed to assist reviewers, not replace human review
-- All findings should be verified by a human reviewer
-- The tool works best with properly formatted Microsoft Word documents
-- Some document types may have "TBD - Need to research" for required headings as these requirements are still being documented
-
-## Technical Requirements
-
-- Microsoft Word must be installed on your computer
-- The document must be in .docx format
-- Python must be installed with the required libraries:
-  - python-docx
-  - logging
-  - re (regular expressions)
+# Document Checker Tool  
+**Ensuring FAA Document Compliance and Consistency**
+
+---
+
+## 1. Introduction
+
+### Purpose  
+The **Document Checker Tool** aims to:  
+- Improve consistency and compliance with FAA and regulatory guidelines.  
+- Automate tedious manual checks, providing faster and more accurate results.  
+- Enhance clarity and professionalism in FAA documentation.
+
+This tool provides **suggestions**, but the final editorial decisions rest with the document author.  
+
+### Scope  
+The tool supports all FAA document types AIR-646 supports and includes 15 categories of checks. 
+
+The tool adheres to style and guidelines derived from:  
+- GPO Style Manual  
+- FAA Orders  
+- Document Drafting Handbook  
+- AIR-600 Quick Reference Guide  
+- Internal memos, templates, and more  
+
+---
+
+## 2. Checker Categories Overview  
+
+### 15 Key Checker Categories  
+1. **Heading Title Checks**  
+2. **Heading Period Format Check**  
+3. **Acronym Check**  
+4. **Acronym Usage Check**  
+5. **Terminology Checks**  
+6. **Section Symbol (§) Checks**  
+7. **Table Caption Check**  
+8. **Figure Caption Check**  
+9. **Table/Figure Reference Check**  
+10. **Referenced Document Title Format Check**  
+11. **Double Period Check**  
+12. **Spacing Check**  
+13. **Date Format Check**  
+14. **Placeholder Content Check**  
+15. **Parenthesis Balance Check**
+
+---
+
+## 3. Details of Each Checker  
+
+### Heading Checks  
+
+#### 1. Required Heading Title Check  
+Verifies required headings are present and properly formatted based on document type.  
+
+**Examples:**  
+
+- **Advisory Circulars:**  
+  - Purpose  
+  - Applicability  
+  - Cancellation  
+  - Related Material  
+  - Definition of Key Terms  
+
+- **Federal Register Notice:**  
+  - Purpose of This Notice  
+  - Audience  
+  - Where Can I Find This Notice  
+
+- **Order:**  
+  - Purpose of This Order  
+  - Audience  
+  - Where to Find This Order  
+
+#### 2. Heading Period Format Check  
+Ensures headings have or do not have periods based on document type.  
+
+**Examples:**  
+- **Required Period:** Advisory Circular, Order, Technical Standard Order  
+- **No Period:** All other document types  
+
+---
+
+### Acronym and Abbreviation Checks  
+
+#### 3. Acronym Check  
+Ensures acronyms are defined at first use.  
+- **Example:** Federal Aviation Administration (FAA)  
+
+#### 4. Acronym Usage Check  
+Identifies acronyms defined but not used.  
+
+---
+
+### Terminology Checks  
+
+#### 5. Terminology Usage Check  
+Flags outdated or vague terms and enforces FAA terminology standards.  
+
+**Examples:**  
+- Replace "shall" with "must" per GPO Style Manual.  
+- Replace "flight crew" with "flightcrew" per AIR-600 Quick Reference Guide.  
+
+---
+
+### Section Symbol (§) Checks  
+
+#### 6. Section Symbol Usage Check  
+Ensures proper formatting for section symbols.  
+
+**Examples:**  
+- Replace "14 CFR § 21.21" with "14 CFR 21.21".  
+- Replace "§ 25.25 and 25.26" with "§§ 25.25 and 25.26".  
+
+---
+
+### Table and Figure Checks  
+
+#### 7 & 8. Table/Figure Caption Checks  
+Verifies captions follow correct numbering conventions based on document type.
+
+**Examples:**  
+- Table X-Y and Figure X-Y for Advisory Circulars and Orders.  
+- Table X and Figure X for all other document types.
+
+#### 9. Table/Figure Reference Check  
+Ensures references are lowercase mid-sentence and capitalized at the start of a sentence.  
+
+---
+
+### Document Title Checks  
+
+#### 10. Referenced Document Title Format Check  
+Verifies correct formatting of referenced document titles.  
+
+- **Italicize:** Advisory Circulars  
+- **Quotation Marks:** Airworthiness Criteria, Deviation Memo, Exemption, Federal Register Notice, Order, Rule, Special Condition, Technical Standard Order
+- **No Formatting:** Policy Statement and all others 
+
+---
+
+### Punctuation and Spacing Checks  
+
+#### 11. Double Period Check  
+Flags unintended multiple periods.  
+
+**Example:**  
+- Corrects: "This sentence ends with two periods..".  
+
+#### 12. Spacing Check  
+Ensures proper spacing around references.  
+
+**Examples:**  
+- Replace "AC25.1" with "AC 25.1".  
+- Remove double spaces between words or after periods.  
+
+---
+
+### Date Format and Placeholder Checks  
+
+#### 13. Date Format Consistency Check  
+Ensures dates follow the "Month Day, Year" format in the document body.  
+
+**Examples:**  
+- Replace "1/15/24" with "January 15, 2024".  
+
+#### 14. Placeholder Content Check  
+Flags placeholders like "TBD" or "To be added."  
+
+---
+
+### Parenthesis Balance Check  
+
+#### 15. Parenthesis Balance Check  
+Verifies that all parentheses are properly opened and closed.  
+
+**Examples:**  
+- Add a missing closing parenthesis to "The system (as defined in AC 25-11B performs...".  
+
+---
+
+## 4. Practical Applications  
+
+1. **Efficient Document Review:** Automated checks save time and reduce errors.  
+2. **Consistency Across Documents:** Ensures adherence to FAA standards.  
+3. **Enhanced Collaboration:** Simplifies document updates for teams.  
+
+---
+
+## 5. Conclusion and Future Updates  
+
+### Key Takeaways  
+- Automated checkers enhance accuracy and compliance.  
+- Tailored for FAA documentation needs.  
+- Saves time while improving document quality.  
+
+### What's Next?  
+- Continue refining the tool to improve accuracy and functionality.  
+- Explore adding new checks based on user feedback and evolving guidelines.  
+- Investigate ignoring specific sections like the Table of Contents for better results.  
+
+**Note:** This tool is a work in progress. Expect more features and updates in the future to meet evolving document requirements.