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

Views: 83

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!

Albuquerque's Community Forum

Microsoft Team Foundation Server 2013 ... Yay or Nay?

Started by AriesSweet Sep 30, 2014.

JIRA users anywhere? 2 Replies

Started by AriesSweet. Last reply by AriesSweet Nov 21, 2013.

Startup Weekend Albuquerque

Started by Eric Renz-Whitmore Jun 19, 2013.

Web Programmer Open

Started by Shannon Jun 11, 2013.

Latest Activity

Profile IconDuke City Fix via Facebook
Thumbnail

More #TBT photos our the Duke City!

#TBT - The Duke City

dukecityfix.com

Some vintage photographs found on the internet web tubes!…

See More
Facebook1 hour ago · Reply
Adelita commented on Brian Fejer's blog post #TBT - The Duke City
1 hour ago
Adelita liked Brian Fejer's blog post #TBT - The Duke City
1 hour ago
Brian Fejer's blog post was featured
1 hour ago

Regular Features

Anyone can blog on the Duke City Fix, but here are the folks who blog most often:

© 2016   Created by Duke City Fix.   Powered by

Badges  |  Report an Issue  |  Terms of Service