Technical Writing Edits

Ego and the technical writer

Technical writing relies on delivering accurate and precise information. Commonly, management and designated subject matter experts review all work performed prior to a documentation release. It is important to understand that a documentation review is not personal; diction and style is always a point of critique.

The famous English actor and scriptwriter Michael Knowles once said:

"Leave your ego at the door. Big egos cause big problems. Give me one good, persistent writer with a small ego and the two of us will do the work of ten"





Once the work has been fully planned we now instigate the following steps:


Test Cases

When a test is formally written up, this is known as a test case and has three parts.


This section contains general information about the test, such as:


This describes the actual test in the following terms:


Test Tracking

Testing needs to ensure that the document fulfills the stated requirements of the project. When the requirements are established, each requirement must have a stated test. It is necessary that each requirement be testable, otherwise the requirement is pointless.


The text is prepared and has been thoroughly tested, now is the time to create the documentation.


Although the main body of the text is complete, updates are inevitable. Feedback from actual users will also form part of the process for implementing changes.


Documentation development begins during the Planning stage of SDLC. When you write for development you write and participate as a team member in all aspects of development content. Developing process documents, proofing requirements, design, and technical specifications; and writing training documentation can be a part of your role.

Types of documentation delivery expectations for this stage:

Check list