One of the top challenges for a company’s internal IT staff is not having enough time during the normal work day schedule to develop proper Information Technology (IT) documentation. This is typically because they are usually very busy solving issues day-to-day so the End Users remain as productive as possible. Other reasons for not properly documenting IT systems include lack of proficiency with writing, lack of proficiency with applications (like Microsoft Visio, Word, Excel), lack of desire, and lack of standards to follow.
Technical Writers develop documentation to explain complex ideas to technical and nontechnical audiences. This could mean telling a Systems Administrator how to perform backup operations using tape library appliance, or telling an End User how to map a network printer.
Technical Writers gather information from existing documentation, and from subject matter experts. A subject matter expert (SME) is any expert on the topic the writer is working on. Technical Writers usually are not SMEs themselves.
Equilibrium’s Technical Writers are proficient at developing the following types of Information Technology (IT) documentation:
- Systems Configuration Documentation
- Standard Operating Procedures
- Systems Recovery Procedures
- Microsoft Visio Illustrations (e.g. network topologies, server racks, etc.)
- Flow Charting Workflow Processes
- Flow Charting Logic Diagrams
- Return on Investment (ROI) calculations
- Break Even Analysis computations
Would you like to see a few examples of our IT Documentation?
Click here to request a consultation with one of our Senior Consultants or call us at 773-205-0200.
