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: 76

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

Dee Cohen commented on Dee Cohen's blog post ABQ Pics: What Size, Pilgrim?
1 hour ago
Dee Cohen's 2 blog posts were featured
1 hour ago
Dee Cohen posted blog posts
1 hour ago
Dee Cohen liked Adelita's blog post Thirty Car Doors = Auto Hawk
1 hour ago
Sophie's 2 blog posts were featured
8 hours ago
Vernon's posted events
8 hours ago
Vernon's updated an event
Thumbnail

The DCN Trio at Vernon’s Black Diamond Lounge

October 18, 2014 from 7:30pm to 10:30pm
8 hours ago
Vernon's's event was featured
Thumbnail

Rudy Boy Experiment at Vernon’s Black Diamond Lounge

October 4, 2014 from 7:30pm to 10:30pm
8 hours ago

Members

Regular Features

• "Sunday Poetry" with The Ditch Rider Johnny_Mango

• Daily Photo by Dee

• "Morning Fix" with Phil_0, SophieAdelitaKitson

© 2014   Created by Duke City Fix.

Badges  |  Report an Issue  |  Terms of Service