This page contains the details of a technical writing project accepted for Google Season of Docs.
Project summary
- Open source organization:
- LLVM Compiler Infrastructure
- Technical writer:
- DR87
- Project name:
- Restructure LLVM documentation index and documentation style guide
- Project length:
- Standard length (3 months)
Project description
This project includes the following tasks:
a.) Restructure the documentation index page to provide a more user-friendly experience. This task will involve evaluating the current page and restructuring it based on a combination of independent research, SME interviews, and user feedback. Possible options include revising the short descriptions, restructuring the existing page, and/or adding additional layers (pages) via a progressive information disclosure model. The latter would reduce the number of links on the main index page to make it easier for users to locate specific information/guides. For example, the index might include links to separate pages for LLVM Design & Overview, User Guides, Subsystem Documentation, and Development Process Documentation.
b.) Update the LLVM Sphinx style guide for open-source contributors. This task will include evaluating the current guide, identifying gaps through independent research and SME interviews, and updating the guide based on agreed-upon requirements. Updates could include reorganizing the layout of the guide, adding new content, and inserting links to relevant pages, such as the contributor guide. The end goal is to make it easier for volunteers to start contributing ASAP.