It is divided into two parts
- TechnicalDocumentation– It is used for developers and technical specifications. For developers how to develop a document and also use for information flow
- UserDocumentation– It is used for common users. It helps to understand that how to use the document, install, configure and deploy.
Uses of technical writing in technical fields
Technical writing is writing in technical communication used in technical fields and it is the process of sharing information about products in technical words such as computer hardware and software engineering. Technical writing can be written in simple words that’s customer can be able to understand the complex information, concepts or processes.
A technical writer can perform this work in various companies. Most of the companies’ use technical writing in India for customers, investors such as Ascezen Consulting uses different technical writing tools as per customer specifications and projects. A technical writer uses different writing skills in writing a technical manuals and updating information in documents. These technical documents help in understanding about company’s products and goal for the users.
Advantages of authoring tools in technical writing
Technical writing is written in various forms such as user manuals, business proposals, product specifications, resumes and job applications in attractive technical language.
Single sourcing online help authoring tools such as Adobe Robohelp and Madcap Flare are used in online help simultaneously in CHM format, context sensitive webhelp and offline documentation such as eBooks, technical user manuals and PDF’s (Portable Document Format).
PDF- is a format to present documents of application software hardware and operating systems. It is a fixed layout technical document including the text, fonts, graphics and other information to display on the web.
CHM –It is an format of compiled HTML and used for software documentation
Web Help- It is an online help for HTML files on a computer and allows delivering HTML files and also using for browser such as Mozilla Firefox and Google Chrome.
Microsoft word-It is commonly used as the format for sending text documents due to computer can read a word document by using word application.
EPUB(ElectronicsPublications) – It is a free and open e-book standard by the International Digital Publishing Forum (IDPF). It can optimize text for a particular display device.
DDLC (DocumentDevelopmentLifeCycle) – It is a complete life cycle of a documentation task. Software documentation requires a well-defined methodology completion.
SDLC(SystemDevelopmentLifeCycle)- It is also known as application development life cycle. It is used in systems engineering, information systems and software engineering to describe a process for planning, creating, testing and deploying an information system. It is applied to both of the software and hardware.
Softwareengineering– Waterfall model, Spiral model (Traditional approaches), Agile, scrum (new approach)
Waterfallmodel– It is a sequential design process used in software development processes in which progress is seen as flowing steadily downwards (like a waterfall) through the phases of conception , initiation,analysis,design,construction,testing, production,implementation and maintenance.
Spiralmodel–It is a risk driven process model generator for software projects.
Scrum – It is an iterative and incremental agile software development methodology for managing product development. It works in sprint cycles i.e. in 7days, 15 days, and 21 days.
Sprint- It is the basic unit of development in scrum and a timeboxed effort i.e. restricted to a specific duration. The duration is fixed in between in one week or in one month.
A release has many sprints
RequirementsGATHER–It is an analysis of requirement and documenting and creates design in high and low level and then develop coding, test and deploy.
Responsibilities –The responsibilities of technical writer in an organization isto know and understand requirements of system or software to be develop
- By listening to Analyst,Clients,Testers and Senior Developer
- By asking relevant questions like who will use, what they will achieve, how will they perform?
- Making briefly documents or notes.
- Forming a list of documents needed.
- Making an outline for each document
- Getting it approved from expert,analysts,architects and managers
- Forming content for sections and chapters (Using writing standards, guidelines and templates) –
- Associated Press
- Sun style guide
- Apple style guide
- Chicago manual of style
- Company specification
- Get approved
- Apply feedback changes
- Generate final output
How to gather information
- Reading requirements documentation
- Accessing and working on a product prototype or test application or demo product
- Change requests need to track for changes in application design.
Be particular about
- Sequence of steps
- Precautions, warnings
- Do’s and Don’t
Anatomyof USER MANUAL
- Cover page
- Table of contents
- Chapters 1- (Header and footer,page no, heading styles)
- APPENDICES ( Appendix)