Software Project Documentation

1

FCC is doing really great both on website and youtube channel. got to learn a lot. BUT there is no content regarding software project management and documentation?

1 Like
2

there is a lot of stuff also on freecodecamp.org/news, but note that freeCodeCamp doesn’t want to be comprehensive of everything, even if it’s growing

as documentation goes you may be interested in devdocs.io, an open source project also maintained by freeCodeCamp

2 Likes
3

Thanks. I just wanted a standard way to document software project. I wasn’t talking about reference docs to be used by developers. I was talking about a standard way to document your current project so that new developers on board can understand it. What are the key points to write in it?

1 Like
4

Here’s a cool article I found on dev.to that might help

And another from the FCC publication:

Both have helped me and I’m pretty sure they can help you too.

Best,
Cy499_Studios

1 Like
5

There isn’t.

IMO https://documentation.divio.com is the best overview of what, ideally should be there.

Documentation guide — Write the Docs is a very good collection of resources.

2 Likes
6

Thank you everyone for sharing awesome content.

7

This topic was automatically closed 182 days after the last reply. New replies are no longer allowed.