Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: problem statement and development plan adjustment #102

Open
17 tasks
aarnphm opened this issue Oct 12, 2024 · 0 comments
Open
17 tasks

chore: problem statement and development plan adjustment #102

aarnphm opened this issue Oct 12, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@aarnphm
Copy link
Owner

aarnphm commented Oct 12, 2024

The following feedback from Hunter highlights areas for improvement in the Problem Statement, Goals, and Development Plan. The suggested changes aim to enhance clarity, readability, structure, and completeness:

  1. Problem Statement:

    • Condense the problem statement into a concise paragraph that motivates the problem.
    • Avoid including optional stretch goals in the inputs/outputs section.
    • Revise the environment section to focus on "what is being implemented" rather than "how it is being implemented."
    • Reframe the beginning motivation to avoid first-person phrasing (e.g., replace "we" instead of "me").
  2. Goals:

    • Add more goals related to user interactions with the software (e.g., user-friendliness, intuitiveness).
    • Expand on the goals to include information about their purpose and how to measure them.
    • Ensure goals are properly motivated and distinguish them from listed requirements.
  3. References and Links:

    • Properly implement links and references for readability.
    • Fix any spelling and grammar errors throughout the document.
  4. Team Roles:

    • Revisit the roles section to make roles more flexible and better defined.
    • Remove the "BDFL" role and replace it with a more adaptable structure.
  5. Git Workflow Plan:

    • Add more details about issue templates, tags, and other organizational aspects for the Git workflow.
  6. POC Demo Plan:

    • Rewrite the POC Demo Plan risks section using clear language that a layperson can understand.
  7. Reflections:

    • Add more detail to the reflections section, particularly in terms of requirements and addressing specific questions.
    • Ensure the reflections align with the goals and motivation of the document.
  8. Formatting and Style:

    • Fix formatting issues to improve readability.
    • Ensure the document is free of spelling and grammar errors.
@aarnphm aarnphm self-assigned this Oct 12, 2024
@aarnphm aarnphm added the documentation Improvements or additions to documentation label Oct 12, 2024
@aarnphm aarnphm changed the title chore: problem statement chore: problem statement and development plan adjustment Oct 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant