Skip to content

Proposal for Enhancing LabPlot's and Cantor's Documentation

KDE Project Proposal: Enhancing Cantor's Documentation

Project Abstract

This project is dedicated to enhancing the documentation of KDE's Cantor and LabPlot applications. The primary focus is on converting existing documentation, tutorials, and books for programming languages like R and Maxima into QtHelp format for integration into Cantor. Additionally, this project aims to overhaul and expand the LabPlot documentation using Sphinx to improve quality and accessibility.

Proposal

  1. Documentation Conversion for Cantor:

    • Convert existing documentation of various programming languages and systems (R, Maxima, etc.) into QtHelp format.
    • Ensure that the converted documentation integrates seamlessly with Cantor, enhancing user experience for syntax lookups and other functionalities.

  2. Enhancing LabPlot Documentation:

    • Transition and update LabPlot's existing documentation from the KDE wiki to Sphinx, ensuring a high-quality and consistent style.
    • Expand the content to cover more features, user guides, and tutorials, including the notebook interface provided by Cantor.

  3. Technical Skills and Experience:

    • Utilize my knowledge in Python and HTML for effective documentation conversion.
    • Apply my experience in handling different documentation formats and technical writing to produce clear, concise, and useful documentation.

  4. Collaboration and Communication:

    • Work closely with the developers of Cantor and LabPlot to ensure documentation accuracy and to stay aligned with the latest developments in both applications.
    • Establish a regular feedback loop with users and developers for continuous improvement of the documentation.

  5. Quality Assurance and Accessibility:

    • Commit to producing high-quality documentation that matches the standard of Cantor and LabPlot applications.
    • Ensure the accessibility of documentation, making it user-friendly for a diverse range of users.

  6. Future Plans and Maintenance:

    • Set up a systematic process for regular updates and maintenance of the documentation to keep it current with ongoing application updates.
    • Plan for a long-term strategy to manage and update documentation, keeping in mind the potential future merger of Cantor and LabPlot.

Here is a diagram to visualize the proposal:

flowchart TD
    A[Start] -->|Familiarization| B[Study Existing Documentation]
    B -->|Learn Tools| C[Familiarize with QtHelp & Sphinx]
    C -->|Initial Conversion| D[Convert Documentation to QtHelp for Cantor]
    D -->|Transition to Sphinx| E[Update LabPlot Documentation in Sphinx]
    E -->|Expansion| F[Expand LabPlot Documentation Content]
    F -->|Iterative Review| G[Review & Implement Feedback]
    G -->|Quality Assurance| H[Ensure Documentation Quality and Accessibility]
    H -->|Ongoing Updates| I[Regular Updates & Maintenance]

Timeline and Milestones

  • Phase 1: Preparation and Familiarization (January 17 - January 24)

    • Study existing documentation of R, Maxima, and other systems.
    • Familiarize with the QtHelp framework and Sphinx.

  • Phase 2: Initial Conversion and Transition (January 25 - February 21)

    • Start the conversion of documentation to QtHelp format for Cantor.
    • Begin transitioning LabPlot documentation to Sphinx.

  • Phase 3: Expansion and Refinement (February 22 - March 28)

    • Continue with documentation conversion and expansion for LabPlot.
    • Begin iterative review and feedback implementation.

  • Post-Project

    • Establish a regular review and update process for both Cantor and LabPlot documentation.

Challenges and Strategies

  • Technical Adaptation: Engage in self-learning and mentor guidance to quickly adapt to the technical requirements of QtHelp and Sphinx.
  • Collaborative Communication: Maintain regular communication with the development teams for up-to-date information and collaboration.
  • User Feedback Integration: Implement structured mechanisms to gather and incorporate user feedback into the documentation.

References / Relevant Background Info

My previous experiences and contributions make me a strong candidate for this project:

Google Season of Docs Experience:

  • ASYNCAPI Initiative (May 2023 - November 2023):

    • As a Technical Writer, I created clear, precise open-source documentation in collaboration with core developers.
    • Engaged actively with the community, initiating discussions and facilitating decision-making.
    • Demonstrated my ability to grasp complex technical concepts and translate them into user-friendly documentation.
    • Contributions: asyncapi/website/pulls/mhmohona.

  • WasmEdge Runtime (May 2023 - September 2023):

    • Authored detailed documentation for WasmEdge plugin development with a focus on Rust, C, and C++.
    • Enhanced user experience by incorporating necessary visuals into the documentation.
    • Provided technical support to the community, which showcases my commitment to not only write documentation but also ensure its practical usability.
    • Contributions: WasmEdge/website/mhmohona

Other Notable Contributions:

  • Outreachy Internship with Wikimedia Foundation (December 2021 - March 2022):

    • Developed an automated system for matching new Wikipedia articles with Wikidata items.
    • This experience honed my skills in Python and regular expressions, crucial for scripting and data handling in technical documentation.

  • Software Engineer at Leads Corporation Limited (January 2020 - July 2023):

    • Involved in developing AI-based products using natural language processing and computer vision techniques.
    • Managed dataset and developed various engines, which deepened my understanding of technical content and complex system functionalities.

Why Choose Me:

  • My past experiences, particularly in the Google Season of Docs, have equipped me with a unique blend of technical writing, programming, and open-source community engagement skills.
  • I have a proven track record of effectively collaborating with developers and contributing to complex technical projects.
  • My ability to translate technical details into clear, user-friendly documentation aligns perfectly with the goals of the Cantor documentation project.

How to reach you

email - mhmohona@gmail.com

/cc @teams/season-of-kde

Edited by Mahfuza Humayra Mohona