Investigation and implementation of a documentation tool

Overview

Today most of our documentation for our SDKs, operation manuals etc. is created by writing static HTML. The purpose of this thesis project is to improve our current methodology using a more dynamic approach that will affect they way we create, modify and consume documentation content.

The selected thesis worker is to investigate the documentation tools available and the current documentation needs within our business unit. From this survey the thesis worker is to propose and implement a complete and working solution.

Using the same tool, users should be able create, modify and consume documentation content. The tool should be built on web based techniques such as Ajax [3] and be deployed, either as a standalone application or as a web site in an intranet environment.

The following list states a few features that we are interested in.

-Search capabilities.
-Inline editing (using Ajax techniques).
-Versioning through SVN.
-Option to export a project into formats such as PDF (or word).
-Presentation abstraction through XML/XLST and CSS.
-Comment system.
-Ability to import static HTML (javadoc/doxygen generated pages etc.).

The technologies and tools used to produce the solution should be based on open-sourced software. For example, the Eclipse help system [1] could be a good starting point for this project as described in [2].

If time permits, an extra task will be to investigate a solution for generating “javadoc inspired” documentation for a JavaScript framework that we have developed.

Expected Output

-Investigation of available documentation tools that supports the chosen solution
-Investigation of current needs within Motorola that supports the chosen solution
-Report describing the design decisions
-Documentation of the software
-The resulting documentation tool

Required Skills

-Java
-HTML/CSS
-XML/(XLST)
-JavaScript/(Ajax)

Conditions

The work will be done at our Kista office, but one or more trips to Linköping might be required. In such case, expenses will be paid by Motorola. We also offer some payment when the thesis has been approved by the university.

Contact Information

Niels Bosma
Motorola, IPVS Sweden.
Isafjordsgatan 35, Box 1115
[email protected]
+46 733 51 76 77

References

[1] http://www.eclipse.org/
[2] http://www-128.ibm.com/developerworks/opensource/library/os-echelp/
[3] http://www.adaptivepath.com/publications/essays/archives/000385.php