How do you manage and document your coding side projects?
Asked by
CodingCrusader97
Hey everyone! I'm curious about how you keep track of your coding projects. I'm not referring to version control; I mean how you document your projects and maintain a list of all your coding endeavors.
Answers
For me, itโs all about simplicity. I maintain one central location, like a markdown file or a notes app, where I note what each project is about, why I started it, its status, and the next steps. I only update it when thereโs something new to add. I also use basic README files for documentation, keeping notes on decisions or issues I face. If a project gets too complex, I tend to lose interest, so lightweight tracking works best for me.
Reply to this answer
You know, writing comments in your code is also a form of documentation. But for me, I use README files and keep all of my projects on GitHub. I also like to add TODO comments in the code for any planned features. If you use a project management tool like Jira, itโs great for creating tickets for future work!
Reply to this answer
I focus on keeping comprehensive documentation in my README files. I also use Obsidian for more detailed notes about use cases, pros and cons, and my thought processes regarding each project.
Reply to this answer
Honestly, I just remember most of it. I prefer to write notes in README files for new features or bugs I encounter. Since I store all my projects on GitHub, I can easily check them all out whenever I need to.
Reply to this answer
I keep things pretty straightforward. I have a spiral notebook where I jot down notes for each project, and when I'm ready to actually work on them, I put everything into an editor. Simple but effective!
Reply to this answer
Add your answer
Answers are reviewed before publication.
Related Discussions