I intend to use the bonding period to further familiarize myself with the intricacies of the above-mentioned tools. Currently, I am familiarizing myself with Babel workflow and how to build. po files in order to implement i18n and l10n. Hence, I was able to build VLC documentation without much issue and am familiar with reStructured Text, the formatting used.įor translations, VLC is using Babel to generate. I was slightly familiar with ReadTheDocs, which is a good tool for versioning and for hosting technical documentation.
I have had some past experience using Git and GitHub, which helped me in getting a hang of GitLab, although there were certain different features that took some time to learn.Īs for Sphinx, I had read about it when a fellow open-source enthusiast had remarked how many organizations are using it for building their documentation (with the notable example of Blender, which uses Sphinx for building their User Manual and API documentation). The new documentation is being built by Sphinx and hosted on ReadTheDocs, and the version control system is implemented in GitLab.
The right balance can be achieved by mentioning pre-requisites at the start of the page or keeping optional sections that the well-versed can skip.įor building translations, the target audience is developers/users of VLC with a good grasp of English and the language they would be translating to. On the other hand, it shouldn't be too long or explanatory (especially the CLI section) that the coders lose interest. I believe that the language of the documentation (especially the GUI section) should be toned down enough that a person with nominal exposure to operating computers would be able to understand and implement the guide. Hence, I plan to include both GUI-based instructions (along with images where relevant) and CLI-based methods (along with code snippets) so that the end-user has freedom of choice.
The target audience is both a curious user who wishes to explore the features of the VLC media player beyond an ordinary media player, and to some extent, it will help developers as well by serving as an easy reference guide. The transition is in progress to go from the wiki-based older documentation to the sphinx built modern user documentation hosted on ReadTheDocs. The VLC User Documentation is in the process of being modernized and being updated. Project summary Open source organization: VLC Technical writer: Abhishek Pratap Singh Project name: Continue the Modernization of the VLC user documentation Project length: Standard length (3 months) Project description CURRENT STATUS OF THE DOCUMENTATION This page contains the details of a technical writing project accepted for
0 kommentar(er)
