DEV Community

Cover image for Goodbye to Manual Docs! Auto-Generated Documentation in Your GitHub Workflow
Abrar Fairuj
Abrar Fairuj

Posted on • Edited on

Goodbye to Manual Docs! Auto-Generated Documentation in Your GitHub Workflow

When you are working in teams, you are asked to document your codes. Well, that makes sense, but writing big brain codes and then spending hours to explain that thing? That doesn't really sound exciting, does it? 🤡

I asked people how they do this on r/webdev, just a few days ago, and this is what people said:

poll responses

Turns out, most of the web developers don't actually write documentations, other than putting comments (which is technically documenting tho)

Well, it can be Easier

Imagine this: you're coding away, pushing those dumb commits to GitHub, and poof! your documentation magically updates itself 😃. Sounds cool, right?

That's exactly what CodeDocs aims to be.

CodeDocs is an upcoming dev tool, that can automatically generate and update documentations directly in your Github Repo. You simply connect your Github project, and that's it! The rest is done automatically ⚡

codedocs demo

This gif is a concept demo, not the actual look of the tool

Moreover, whenever you push updates, CodeDocs will automatically analyze the updates and make necessary changes to the existing documentation.

How does that Help?

For startups and software agencies, this mean:

1. Save Time 🕙: You no longer need to waste time writing docs, which doesn't really add value to the product itself

writing docs meme

2. Boost Productivity 🐎: You can guess it, the team can focus on actually building the product instead of explaining

3. Smooth Onboarding for new hires:

docs meme

Yea, that won't happen anymore 😛

4. Better Collaboration 💪: Regardless of plan, every team member gets access to CodeDocs tools, that means, flawless collaborations!

5. No More Dumb Docs: Last but not the least, ai automated docs are not this dumb 😛

useless docs meme

Sounds Interesting...

It's now out in BETA! You can try it without monthly limits as beta tester right now!

Learn more here: https://supacodes.com

Have a suggestion or question? Let me know your thoughts!

P.S. Share this with your Product Manager or CTO & save your team

All the memes are collected, I didn't make them, my meme qualities are horrible

Ciao!

Top comments (0)