Skip to content

nickheynen/doit-style-checker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

UW-Madison IT Style Checker

Overview

The UW-Madison IT Style Checker is a web application that helps content creators ensure their writing follows the UW-Madison Editorial Style Guide and DoIT Communications Style Guide. The tool checks text for common style issues, suggests corrections, and provides a "fixed" version of the text that follows UW-Madison's writing standards.

Features

Style Checking

  • Checks text against UW-Madison style rules
  • Identifies errors, warnings, and suggestions
  • Provides context for each issue found
  • Suggests fixes for common problems
  • Creates a corrected version of your text

Rule Categories

The style checker examines text for issues in the following categories:

Formatting Rules

  • UW-Madison name formatting (correct en dash usage)
  • Dates & times formatting
  • Dashes & hyphens
  • Phone number formatting
  • Heading capitalization

Language Rules

  • Passive voice detection
  • University jargon identification
  • Wordy phrases
  • IT jargon
  • Inclusive language

UW-Madison Specific Rules

  • UW-Madison name and references
  • System names and capitalization (MyUW, NetID, WiscVPN, etc.)
  • Academic titles formatting
  • Campus vs. University usage
  • Appropriate terminology

Customization

  • Enable/disable specific rule checks
  • Add custom jargon terms to check for
  • Add university system names with correct capitalization

How to Use

  1. Check Your Text

    • Go to the "Style Checker" tab
    • Paste your text in the input area
    • Click "Check Style" to analyze your content
    • Review the issues found, categorized by severity
    • Use the "Fixed Text" provided as a starting point for revisions
  2. Learn the Rules

    • Visit the "Rules & Categories" tab to understand UW-Madison style guidelines
    • Browse through different categories: capitalization, dates & times, punctuation, etc.
    • See examples of correct usage
  3. Customize the Checker

    • Go to the "Custom Settings" tab to enable/disable specific rules
    • Add your own custom terms to check for
    • Add system names with their correct capitalization

Accessibility

This tool is designed with accessibility in mind:

  • Follows WCAG accessibility guidelines
  • Works with keyboard navigation
  • Compatible with screen readers
  • Includes skip navigation links
  • Features appropriate color contrast
  • Provides clear error messages and feedback

Resources

Technical Details

  • Built with HTML, CSS, and JavaScript
  • No external dependencies or backend requirements
  • Settings saved to browser's localStorage
  • Compatible with modern browsers (Chrome, Firefox, Safari, Edge)

Version

Version 1.0 - March 2025

Developed by UW-Madison IT Communications based on UW-Madison style guidelines and brand standards.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published