Comments on: Who Will Maintain Your Documentation? http://www.gryphonmountain.net/2009/12/who-will-maintain-your-documentation/ Technical Communication and Other Writing Topics, by Ben Minson Wed, 11 Jan 2012 04:05:49 +0000 hourly 1 http://wordpress.org/?v=3.0.4 By: Ben http://www.gryphonmountain.net/2009/12/who-will-maintain-your-documentation/#comment-427 Ben Tue, 15 Dec 2009 01:52:48 +0000 http://www.gryphonmountain.net/?p=799#comment-427 Your comment points out the need for contractors to take into account all this meta-documentation when giving an estimate on their work. It's a good idea to find out what the client's plan is for maintenance after you're done, and then include in your estimate the effort you've described. Your comment points out the need for contractors to take into account all this meta-documentation when giving an estimate on their work. It’s a good idea to find out what the client’s plan is for maintenance after you’re done, and then include in your estimate the effort you’ve described.

]]> By: Margaret http://www.gryphonmountain.net/2009/12/who-will-maintain-your-documentation/#comment-426 Margaret Thu, 10 Dec 2009 17:21:35 +0000 http://www.gryphonmountain.net/?p=799#comment-426 Whenever I've left a job, whether a short-term contract or a "permanent" position, I thave tried to leave the documentation projects in the form I'd like to find them in if I were to come back in a year and pick them up again. I organize all the documents, screenshots, and related illustrations into a set of nested directory folders that show what goes with which document. I also create a Read-Me file for each project or doc set, that lists the files and directories included, how they are organized, with a copy of the template(s) used. If a particular style guide was followed, I include that in the Read-Me file, too. If I expect that the documents may be updated by employees that are not technical writers, I try to modify the Template into a tutorial on how the various styles are used in the documents, and how to modify tables, insert figures, use numbered and bulleted lists (and which styles to use for each. I even leave a phone number and offer to answer reasonable document related questions. I take a copy for my portfoilio (if permitted) and that will enable me to refer to the document(s) if I do get questions. Whenever I’ve left a job, whether a short-term contract or a “permanent” position, I thave tried to leave the documentation projects in the form I’d like to find them in if I were to come back in a year and pick them up again.

I organize all the documents, screenshots, and related illustrations into a set of nested directory folders that show what goes with which document. I also create a Read-Me file for each project or doc set, that lists the files and directories included, how they are organized, with a copy of the template(s) used. If a particular style guide was followed, I include that in the Read-Me file, too.

If I expect that the documents may be updated by employees that are not technical writers, I try to modify the Template into a tutorial on how the various styles are used in the documents, and how to modify tables, insert figures, use numbered and bulleted lists (and which styles to use for each.

I even leave a phone number and offer to answer reasonable document related questions. I take a copy for my portfoilio (if permitted) and that will enable me to refer to the document(s) if I do get questions.

]]>