Contact Us Search Site Index About This Site Decrease text size Increase text size Georgetown University main web site Contact Us Search Site Index About This Site
spacer spacer spacer
University Information Services at Georgetown University
Faculty HelpStaff HelpStudent HelpAbout UIS
clear clear

Index

UIS Technical Writing Style Guide

"If content is what we communicate, then style is how we communicate that content."

- Sun Microsystems Technical Publications

A writing style is determined by decisions made during document creation, such as type, tone, choice of words, language, format consistency, use of technical terms, and so forth. Good style is synonymous with effective writing style.

The Writing Style Guide is a UIS publication that provides specific detail of the UIS writing style. It includes screen terminology and naming conventions; spelling and acronyms for technical terminology; grammar and English; and guidance for writing procedural instructions. For instruction and guidelines regarding visual and presentational style i.e. typography, color, and use of University graphics, please reference the University Web Style guide.

The style guide has been developed from several sources: The Chicago Manual of Style. 15th ed; Sun Microsystem's Read Me First! A Style Guide for the Computer Industry, Second Edition (Paperback); Microsoft's Manual of Style for Technical Publication; and the Oxford English Dictionary.

The provision of this style guide is as a reference, best practice, and guidance tool for those who develop user documentation relating to UIS publications and information architects in general. UIS requires use of the style guide as often as possible.

 

  • Writing How-to Documentation...(Procedures)
  • Grammar and English

 

For questions or issues regarding the style guide, please contact:

Tumpa Rahman tr94@georgetown.edu

Steve Ruder sdr28@georgetown.edu

Quick Links

: Report a Problem
: Access+
: Anti-virus Software Downloads
: Blackboard Login
: Directory
: Email-NetID Tools
: Financial Access+
: Glossary
: GMS
: Green IT
: GUMail-Faculty
: GUMail-Staff
: GUShare
: GUWebCalendar
: How-to Documentation
: Hoya Computing
: Hoyamail
: Information Security
: Media Adapters
: MyAccess
: Policy Information
: Protect Your Computer
: ResNet
: Software Downloads
: Spam Blocking Stats
: Sponsored University Associates
: Student Access+
: Training Classes
: UIS H1N1 Resources
: UIS Tip of the Week
: Wireless Instructions
: Work for UIS

spacer