Software and IT Documentation

Whether you are a software development company or an Information Technology department within a larger organization, I can help with your documentation.

User Guides

Your users need clear, concise instructions to get the most out of your applications. I can write those instructions after working with your software and/or interviewing your technical staff. I can also handle situations that may have caused you problems in the past:

  • Templates: I can create new documents based on your existing template, or create a template from scratch that you can use in the future.
  • Lost files: If your current documentation only exists on paper, I can recreate it in Microsoft Word, and then update it if needed.
  • Cross-platform needs: If the software is written for Windows, but the graphics department needs Macintosh files, I can accommodate them.

Help Files

If your users have questions or problems while they are in the middle of their work, they will appreciate a thorough on-screen help feature. I can write your application's help file.

System Administrator Manuals

Would your day-to-day operations continue smoothly if one or more of your key administrators left unexpectedly? I can interview your technical staff and create a manual that will allow new personnel to come up to speed on backup and restore tasks, running on-demand jobs, and other system administrator responsibilities.

Programmer Documentation

Is your software used by other developers? I can read your Java or C++ code and interview your developers, then document your application's API for an audience of outside programmers.

Samples

Click the thumbnail below to download a sample
user guide.

MS Word user guide

(Read about the proposed series of Target Guides.)

Note: This sample is an Adobe Acrobat file. If you don't have the Acrobat Reader, you can download it from the Adobe Web site.

credentialsSoftware toolsNewslettersManagementHome

Software/IT l Management l Newsletters l Tools l Resume l Home