Procedures | I Heart Technical Writing, Tips, Tools and Templates for Technical Writers

Entries Tagged as 'Procedures'

What is the difference between Procedures and Work Instructions?

September 8th, 2010 · View Comments · Procedures

There is an argument in the office right now about the difference between Procedures and Work Instructions. I’ll give you my take later but wanted to run one definition by you first.

[Read more →]

Tags: procedure·Work Instruction

What Avatar Can Teach You About Project Management 2.0

February 20th, 2010 · Comments Off · Business Process, Communications, Content Management, Procedures, Process Design, Productivity

What’s the one thing you enjoyed most in Avatar? For my Project Management friend it was the video logging. Did you notice that the team kept their reports not in Microsoft Word (i.e. on paper) but as video logs. When trying it out, the protagonist in the movie couldn’t get a handle on it. ‘Don’t [...]

How To Write Technical Documentation For APIs

February 1st, 2010 · View Comments · Content Management, How To, Linkedin, Procedures, Software Development, Technical Writing, strategy

One of the threads on LinkedIn is how to write technical documentation for APIs. It’s been many years since I’ve documented an API (Java & Oracle) so if you have any thoughts on the best way to do this, then please jump in. An application programming interface (API) is an interface implemented by a software [...]