EOS is a disk-based file system designed to be a fast, low-latency, high availability, and elastic storage to capture the results of CERN experiments. Nowadays, EOS has been developed to the stage where it became potentially interesting for enterprise users – that is where Comtrade with its vast experience with enterprise software development came in.
The documentation development process is proposed to be divided into six books and two supplements:
- The realistic use cases of functionality
- The source code corresponding to a specific work package
- Feedback from end-users
- Internal documentation regarding the functionality prepared by developers
- Verification of documentation prototype at the live EOS storage system at CERN
- Set up of EOS corner case environments on virtual hosts (Geo-scheduling, Balancing, Upgrades)
- Best practice guide
- Installation guide
The result of the presented documentation process is the prototype for EOS documentation. This prototype is validated both by domain experts (developers) and end-users. Feedback is implementing into a version that is edited by professional proofreaders. Iterations of revisions between proofreaders and experts are ongoing processes. The final version of this prototype is also designed by the graphic design team.
The presented documentation process is provided as the first step towards establishing EOS as a viable enterprise storage product.