Software Style Guides

Subject: Software Style Guides
From: "Lauren N. Hart" <Lauren_Hart -at- 2is-inc -dot- com>
To: "'techwr-l -at- lists -dot- techwr-l -dot- com'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 29 Feb 2012 14:06:58 +0000

Good morning fellow Tech Whirlers,

I have been tasked with writing an internal software style guide. I have a pretty good draft so far with examples, screenshots, links to files where images and code is stored, but I am having a little bit of difficulty coming up with an exhaustive table of UI Elements, their definitions, examples, usages, etc. I am relatively new to software and do not know all of the official terms used to describe common UI elements (things like modal boxes, popup windows, drop-down menus, etc).

Are there any resources available to provide general UI design and style guidelines? I am modeling the UI Element table after the one in the Microsoft Manual of Style (control name, definition, usage, example), but that is written for an audience of tech communicators, not software developers. The audience of this style guide is the internal software development team. The purpose is so that when they create a new piece of software from scratch, they can just plug in the company-wide font, colors, buttons, modals, etc so that all of the applications look cohesive and follow the same UI style.

Any advice would be appreciated.

Best,
Lauren Hart
www.Twitter.com/_laurenhart_<http://www.Twitter.com/_laurenhart_>
Http://www.writeeditrepeatblog.wordpress.com


This email is intended only for the recipient(s). If you are not a recipient, disclosing, copying, or distributing this information is prohibited. The views expressed in this email are not representative of 2Is, Incorporated.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.

Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.

http://bit.ly/doc-to-help

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

Previous by Author: Re: OT: Blog software suggestions
Next by Author: Re: get rid of the intrusive ads at the top
Previous by Thread: Re: DOS/Windows > UNIX text file conversion utility
Next by Thread: Re: Software Style Guides


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads