I'm working on a project to publish some of my department's documentation to our enterprise WCMS. Our standards committee is struggling with creating basic design criteria such as formatting. For example, when should bold be used, etc. Reasonably, the committee has wondered if we're re-inventing the wheel.
Our audience is primarily end users (UNM faculty and students and some staff) mainly for web-based applications, but stand-alone apps come into it as well.
I was wondering if any of you know of style guides that address writing technical documentation, especially documentation that will appear on the web.
I've sent a similar messages out to specific folks and some lists, so I apologize for the repetition if you see this more than once.
If you belong to LinkedIn, here's a local group you can tap: http://www.linkedin.com/groups?about=&gid=2214390&trk=anet_...
And here's the Web site: http://www.stc-nm-kachina.org/
I'll look into this. Thanks for taking the time to reply!
I've generally found that using the Wikipedia Style Guide covers a lot of possibilities:
Thanks for the lead!
Yeah, a good resource.
Re: Technical documentation style guide. Google knows all, tells all -- http://www.writtendesigns.com/documents/TechnicalStyleGuide.pdf
Re: Writing for the Web. Memorize everything Jakob Nielsen has ever written.
Wow. Tops it all.