Technical Writing

Technical Writing is the production of technical documentation in the form of user and operator documentation, and technical project documentation used to describe complex software systems.

Technical Writing uses both written prose and diagrams to effectively communicate ideas and operations. Diagrams and the Universal Modelling Language (UML) are useful to quickly give an overview of a systems, and to break down more complex parts of a system for quick assimilation. Written prose can be more approachable though if an audience is not familiar with UML or diagramming as exact instructions can be conveyed more readily.

Technical Writers often have to deal with two distinct type of audiences and documentation style: documentation for operators and users, and documentation for the overall project and developers. Operator documentation is generally instructional and attempts to provide clear guidance in how to operate a system. Project documentation addresses the overall system and how it operates and how parts of a system interoperate. Project documentation is useful thought the initial build, and especially later on when any maintenance is required.

Technical Writing Companies

Technical Writing Companies listed in the Guild of Developers Technical Writing Companies Directory Listings are Tech Companies offering a broad range of Technical Writing services.

Technical Writing Listings

Technical Writing Listings

0   1
0   1
Poised Solutions	Poised Solutions Poised Solutions produces both instructional operator documentation (user documentation) and effective system documentation using a variety of Technical Writing styles. Poised Solutions IT Practice offers Technical Writing as part of the System Analysis suie of technical services, and can provide documentation throughout the complete development life cycle, for a wide variety of technical projects, from Web Development, Ecommerce Development and Application Development through to Database Development and System Development.