 StyvasGolf Canucks GolfPremium join:2004-09-15 Hamilton, ON | Anyone do technical writing? I'm really only familiar with academic writing, in which APA and MLA style guidelines are the most prevalent. Is there a style standard that is fairly typically used in technical writing (manuals, user documentation, etc.)? -- "Moving your Tylenol to the low shelf in your medicine cabinet is not the way to prevent children from falling off a stool when reaching for the top shelf." (said by Savant, May 2008) |
|
 donoreoPremium join:2002-05-30 North York, ON | I have taken a technical writing course, but that was a long time ago. |
|
 Tig join:2006-06-29 Carrying Place, ON | reply to Styvas Yes, technical manual and reports,but it's going to take me a bit to come up with a reference document for you. |
|
|
|
 StyvasGolf Canucks GolfPremium join:2004-09-15 Hamilton, ON | I'm guessing that it's not APA or MLA that are typical. More likely something like Turabian or Chicago standard. |
|
 | reply to Styvas a bit off topic but here is guide for PSC style »www.psc-cfp.gc.ca/abt-aps/stgd-g···-eng.htm
The Public Service Commission Style Guide contains the standards to follow when creating Public Service Commission documents. In addition to this, this website also provides you with a variety of general writing style guidelines useful in all forms of correspondence. |
|
 Tig join:2006-06-29 Carrying Place, ON | reply to Styvas I'm afraid it's none of the above. We make our own guidelines and to my dismay the only reference guide I can find online is not free. I'll PM a link for your review. |
|
 ArthurSWatch Those Blinking LightsPremium join:2000-10-28 Hamilton, ON | reply to Styvas
Re: Anyone do technical writing? Any decent technical writing seminars out there? |
|
 | reply to Styvas I use Chicago for academic papers |
|
 | reply to Styvas With tech writing, the applicable style depends on the subject matter or industry for which you are writing. For example, software documentation often follows Microsoft Manual of Style, and IEEE is often used for technical reports. However, many other guides exist (ISO, AP, NYTimes, CMOS...). I recommend avoiding specializing in a single style, and working toward adept adaptation to any style. |
|
 Reviews:
·TekSavvy DSL
| reply to Styvas this topic sucked all the life out me...
To think we when I document, I put keyboard to wiki, and think "Thank god It's documented, users should appreciate I remember to do this!" -- »www.codecipher.com - Marking the way to tomorrow's solutions -- Did you know that Perl is not Dead? »perlisalive.org/ |
|