-
Notifications
You must be signed in to change notification settings - Fork 46
Google Season of Docs
TerosHDL is an open-source initiative dedicated to streamlining the design, verification, and simulation of digital circuits with an intuitive and accessible environment. The goal of TerosHDL is to provide an open source toolbox for HDL developers with functionalities commonly used by software developers. The IDE consists of a bunch of tools and on top of them is VSCodium/VSCode. Some tools are developed by the Teros Technology organization and others come from open source projects. All the tools are organized in different backends and exposed to the GUI with the plugin. Launched in 2018, it serves a diverse array of users, from professional engineers and academics to hobbyists in digital design. Despite its comprehensive features and capabilities, TerosHDL's growth and user engagement are significantly hindered by its current documentation, which is not sufficiently clear, detailed, or user-friendly. This inadequacy impedes users' ability to fully leverage the platform, limiting both their success with the tool and the overall impact of TerosHDL in the field of digital design.
The principal challenge confronting TerosHDL today is the existing documentation's inability to effectively support users in utilizing the software to its full potential. New users, in particular, find it difficult to navigate through the initial setup, understand the core functionalities, or to use the new features due to vague, outdated, or overly technical documentation and guides. Addressing this gap in documentation is essential to unlocking the full potential of TerosHDL for a wider audience and fostering a more vibrant, engaged user community.
- Conduct a comprehensive review and audit of the existing documentation to identify critical gaps, inaccuracies, and areas lacking clarity or completeness.
- Rewrite and restructure the documentation to make it more accessible, engaging, and helpful to users of all experience levels. This includes simplifying complex concepts, providing step-by-step guides, and incorporating visual aids where beneficial.
- Develop a series of beginner-friendly tutorials that cover the basics of digital circuit design within TerosHDL, as well as advanced features, to support users from initial setup to complex project development.
- Create a dedicated troubleshooting section to quickly address common issues and questions, reducing user frustration and support requests. Implement a feedback loop with the user community to continuously refine and update the documentation based on actual user needs and experiences.
Success of the DocEnhance project will be measured by:
- A significant reduction in user-reported issues related to software usability or understanding, aiming for a 40% decrease within the first year post-implementation.
- User feedback surveys conducted before and after the documentation overhaul, demonstrating improved satisfaction with the documentation's clarity, utility, and accessibility.
| Dates | Action Items |
|---|---|
| May | Orientation |
| June and July | Audit existing documentation and create friction log |
| August, September and October | Create documentation |
| November | Project completion |
| Budget item | Amount | Running Total | Notes/justifications |
|---|---|---|---|
| Technical Writers | 10500 | 10500 | |
| Volunteer Stipends | 1000 | 11500 | 2 volunteer stipends at $500 each |
| Graphic design - logos, tutorial diagrams, and visuals to accompany documentation | 3500 | 15000 |
TerosHDL was chosen for the NGI Assure program (https://nlnet.nl/project/TerosHDL/), leading to significant advancements and the introduction of substantial new features that are currently significantly under-documented.