Due to the increased need of software companies in Lebanon to upgrade their documentation and bring it to the international level, ELCIM held the workshop “Technical Documentation in Software Development”.
This workshop lasted for three days, from February 21st to 23rd, 2007 and took place within IRI premises (Industrial Research Institute) were 35 participants from 19 major companies took part in it. It focused on software manuals, product description, and the technical documentation of the software systems.
It started by explaining technical writing, its phases and methodology, types of technical information, and documentation standards. Then best practices were described in analysing input and designing deliverables, writing, proofreading and editing, publishing and delivering, and finally in managing the documentation process. Software manuals were explained by describing user manuals, architecture/ design documentation, source code documentation, and online help.
The workshop was concluded with practical training sessions that handled analysing and evaluating selected technical documents, and finally a discussion of proposed documentation projects through which all the participants got a real feel of the concepts explained..
|
