Writing documentation and READMEs without the boredom

Let’s be real, nobody actually enjoys writing documentation. Building the project and writing the code is the fun part; explaining it all in a text file just feels like boring admin work.

But now that my degree is done and I’m taking my AI-ML classes, I’m spending a lot of time cleaning up my GitHub portfolio for job applications. I recently realized a harsh truth: recruiters and hiring managers do not have the time to read through your raw source code to figure out what your app does. If a project doesn’t have a solid README.md file, they usually just move on.

I had a few projects — like a full-stack Streamlit and Python web app I built a while back — sitting on my GitHub with absolutely zero explanation. Today I decided to fix that using Copilot, and it took me less than a minute per project.

First, I used Copilot Chat to handle the inline comments. I highlighted my database connection file and simply typed /doc. Copilot instantly generated beautiful, formatted docstrings above every single function, explaining exactly what parameters it takes and what it returns.

Then came the magic. I opened an empty README.md file, clicked on the Copilot Chat, and typed: Write a comprehensive GitHub README for this project. Look at my @workspace to understand what the project does. Include a brief description, the tech stack used, and a setup guide on how to run it locally.

Because of the @workspace command, Copilot scanned my entire folder. It figured out the exact Python libraries I was using, explained the architecture, and generated a perfectly formatted markdown file. It even gave me the exact terminal commands (pip install -r requirements.txt and streamlit run app.py) that someone would need to start it up.

I literally just copy-pasted the whole thing and committed it. Suddenly, my GitHub portfolio looks 100x more professional. If you are hunting for jobs and have undocumented projects sitting around, go do this right now.