Skip to content
chapman91 edited this page Sep 1, 2023 · 1 revision

Projects Methodology:

  1. Project Overview: What is the project's purpose? What is the projects's goal? What is the scope?

  2. Planning and Design: Outline Projects's architecture Outline Data structures Outline Algorithms

  3. Code Documentation: Write comments and explanations in your code

  4. Task Lists: Use Github issues or projects board to manage tasks

  5. Error Logs: Document errors and their resolutions.

  6. External References: Make note of external resources or documentation.

  7. Commit Messages: Write meaning full commit messages

  8. Testing and Results: Document the results of testing

  9. Lessons Learned: Reflect on major milestones. Document insights and areas for improvements

  10. Regular Updates: Update your notes as you work and don't try to remember things later

  11. Collaboration: If you are working with collaborators ensure your notes are accessible.

Clone this wiki locally