Hello, everybody:

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.

Thanks!
Greg

Tags: cms, documentation, guide, style

Views: 79

Replies to This Discussion

Hey Greg,

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/

 

best,

Leon

 

 

Hi, Leon:

 

I'll look into this. Thanks for taking the time to reply!

 

Greg

I've generally found that using the Wikipedia Style Guide covers a lot of possibilities:

 

http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style

Good stuff.

Hi, Steve:

 

Thanks for the lead!

Greg

 

Hi, Rob:

 

Yeah, a good resource.

 

Thanks!
Greg

 

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.

Hi, Karl:

 

Nice!

Thanks,

Greg

 

RSS

Connect with Us!

Latest Activity

Duke City Fix liked Shelle VanEtten de Sanchez's blog post Builders and Makers: Deborah Gavel
4 minutes ago
Profile IconDuke City Fix via Facebook
Thumbnail

Another installation of Builders and Makers by Shelle Sanchez! Featured this week is #ABQ painter, art activist, healing artist, and teacher Deborah Gavel. http://www.dukecityfix.com/profiles/blogs/builders-and-makers-deborah-gavel

Facebook10 minutes ago · Reply
Shelle VanEtten de Sanchez's blog post was featured
28 minutes ago
Profile IconDuke City Fix via Facebook
Thumbnail

A sneak peek of Bernalillo County and the City of Albuquerque Public Art's new exhibition "All Over The Map: The Ongoing Dialog of Public Art"

All Over the Map: ExhibitionTeaser with…

See More
Facebook1 hour ago · Reply

Members

Regular Features

• "Sunday Poetry" with The Ditch Rider Johnny_Mango

• Daily Photo by Dee

• "Morning Fix" with Phil_0, Sophie, once banned twice shyKitson

© 2015   Created by Duke City Fix.

Badges  |  Report an Issue  |  Terms of Service