LLVM Compiler Infrastructure project
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["This project aims to improve the LLVM documentation by restructuring its index page for better user experience and updating the style guide to facilitate easier contributions."],["The project involves researching, interviewing subject matter experts, and incorporating user feedback to enhance the organization and accessibility of LLVM documentation."],["Improvements to the documentation index page may include revising descriptions, restructuring content, and implementing a progressive disclosure model for easier navigation."],["Updates to the Sphinx style guide will focus on clarity, comprehensiveness, and providing resources for open-source contributors to quickly get started."],["The project is part of Google Season of Docs and will be completed within a standard timeframe of 3 months by technical writer DR87."]]],["The project aims to improve the LLVM documentation's accessibility and usability. Key actions include restructuring the documentation index page for a better user experience, possibly adding new layers and revising descriptions. Another focus is updating the LLVM Sphinx style guide by identifying gaps, reorganizing the layout, adding new content, and including relevant links to streamline the contribution process for open-source volunteers. The project will involve research, expert interviews, and user feedback.\n"]]
