Institute Of Management And Development New Delhi

Admin | February 01, 2012 | Comments Off

Institute Of Management And Development New Delhi

Institute Of Management And Development New Delhi

While technical writers have their own methods and tools in writing and maintaining documentation for external distribution, other team members are documenting projects too. If the documentation written outside of the technical writing team (requirements, specifications, general coding notes) is done without a formal process, help set the standard.

The goals for this effort should be to:

  • Minimize the possibility of duplicate documentation on individual hard drives or on a shared drive
  • Centralize information so that the latest revision is accessible
  • Provide an auditable trace of previous revisions
  • Enable instant collboration with minimal fuss for SMEs
  • Ensure that proprietary and confidential information is secure
  • Offer a seamless and painless transition to a new methodology (as a good neighbor practice)
  • Find a method that helps the technical writing team communicate with SMEs

Read some of the possible solutions offered below. Assess your team’s workflow, available tools, and budget. Also consider the impact of open source software in your organization.

Source Control Tools

A check-in and check-out control enforced by source control tools ensures that the latest revision is available centrally. Icons will change to show that a document or file has been checked out, flagging users to wait to make edits. Communicate this as the home of development docs, and so it will be.