SoK/2025/StatusReport/Shubhanshu Gupta: Difference between revisions
< SoK | 2025/StatusReport
Created page with " <h2>Simplifying Documentation for a Broader Audience</h2>" |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<h2>Simplifying Documentation for a Broader Audience</h2> | <h2>Simplifying Documentation for a Broader Audience</h2> | ||
<h3>Project Abstract</h3> | |||
My proposal aims to simplify the KEcoLab documentation into simpler, user-friendly sections with clear visuals and concise instructions, while also ensuring that the necessary depth and technical details for the advanced users is retained. This approach will make KEcoLab accessible and useful for a wider audience, regardless of their technical background. | |||
<h3> Deliverables </h3> | |||
* Simpler less technical documentation for general users | |||
* Detailed technical documentation for developers | |||
<h3>Mentors</h3> | |||
* Joseph P. De Veaugh-Geiss @joseph:kde.org | |||
* Kieryn Darkwater @mxdarkwater:matrix.org | |||
* Karanjot Singh @drquark:kde.org | |||
* Aakarsh MJ @aakarshmj:matrix.org | |||
* Pradyot Ranjan @pradyotranjan:gitter.im | |||
<h3>Issues worked on</h3> | |||
[https://invent.kde.org/sdk/kecolab/-/issues/31 How energy measurement has evolved with automation] <br> | |||
[https://invent.kde.org/sdk/kecolab/-/issues/33 How software is remotely simulated—Usage Scenario Scripts]<br> | |||
[https://invent.kde.org/sdk/kecolab/-/issues/36 User Guide Page] <br> | |||
[https://invent.kde.org/sdk/kecolab/-/issues/41 Project Structure Page] | |||
<h3>Weekly Progress</h3> | |||
Latest revision as of 13:42, 21 March 2025
Simplifying Documentation for a Broader Audience
Project Abstract
My proposal aims to simplify the KEcoLab documentation into simpler, user-friendly sections with clear visuals and concise instructions, while also ensuring that the necessary depth and technical details for the advanced users is retained. This approach will make KEcoLab accessible and useful for a wider audience, regardless of their technical background.
Deliverables
- Simpler less technical documentation for general users
- Detailed technical documentation for developers
Mentors
- Joseph P. De Veaugh-Geiss @joseph:kde.org
- Kieryn Darkwater @mxdarkwater:matrix.org
- Karanjot Singh @drquark:kde.org
- Aakarsh MJ @aakarshmj:matrix.org
- Pradyot Ranjan @pradyotranjan:gitter.im
Issues worked on
How energy measurement has evolved with automation
How software is remotely simulated—Usage Scenario Scripts
User Guide Page
Project Structure Page