Posts Tagged ‘Software’
How a Software Company Looks from Inside
Introduction: The Software Industry in Brief The software industry is a booming market with a high demand for skilled workers at any software company. Software companies are always looking for qualified engineers to fill their ranks. Software engineering is the process of developing computer programs that can solve complex problems, or produce desired effects. Since…
Read MoreHow to Gain the Respect of the Developers & Engineers in a Software Company
© 2010 Ugur Akinci Here is an important article that all technical writers should read; especially those who work or would like work for a software company. The article, written by Eric J. Ray, obviously an industry veteran who knows what he’s talking about, addresses an important issue rarely discussed this openly: for various reasons,…
Read MoreHow to Write a Software Installation Guide
© 2009-2010 Ugur Akinci An installation guide is written to describe the installation of either a mechanical/electronics system (like a child’s swing or a hi-fi set) or a software product. Here we will focus mainly on the latter. A software installation guide overlaps with System Administration Guide since it covers similar configuration tasks. That’s the…
Read MoreTwo Different Types of Software User Manuals in Technical Writing
© Ugur Akinci In technical writing, there are two different but related types of software user manuals and I call them “Button Guides” and “Procedural Tutorials”. A FUNCTION or GUI INTERFACE MANUAL explains what each “button”, or the graphic user interface (GUI) element that one sees on a screen, is all about and how does…
Read MoreTechnical Writing – A Checklist For a Software Document Writing Project
© 2009-2010 Ugur Akinci Here is a general checklist that you might find useful to make sure your software documentation project does not miss anything: Do you have access to the software project’s Scope Document? Do you have access to the functional and marketing specs of the software project? Have you written a Documentation Plan…
Read More