<p>Software documentation is an important aspect of software projects. Software documentation plays a key role in software</p><p>development if it is up-to-date and complete. Software documentation should have the synchronization with the software</p><p>development. One of the problems is duplication; same information is written in different documents and stored in different</p><p>places with different formats making things complex to manage. By using traditional documentation tools, it’s hard to maintain</p><p>documentation for complex systems and it is time consuming.</p><p>To overcome these problems, we have used XML Docbook that is a good solution for it. Docbook provides single sourcing</p><p>technique in which documents are written ideally in one place and can convert it into different other formats from the same</p><p>location. Actually docbook is based on xml which can be easily edited by most of the programming languages. If there are many</p><p>developers are writing documentation for their software modules then we don’t need to copy and paste all the documents into</p><p>one document to produce a complete document for the software product. We have to just add the references to all those files</p><p>that should be present in the final document and then compile it with some processors and it automatically get document</p><p>contents from all files and put it into one document, so it’s easy to handle and maintain software documentation with docbook.</p>
Identifer | oai:union.ndltd.org:UPSALLA/oai:DiVA.org:liu-52484 |
Date | January 2009 |
Creators | Asif, Muhammad |
Publisher | Linköping University, Department of Computer and Information Science |
Source Sets | DiVA Archive at Upsalla University |
Language | English |
Detected Language | English |
Type | Student thesis, text |
Page generated in 0.0017 seconds