Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
-
I'll give you some pointers!
1) What language is you code in?
2) What IDE do you/team user? (not important you all use the same one, but might give you some nice shortcuts")
3) Are you trying to document just a few outward facing classes/methods/interfaces, or do you just want documentation on everything? -
4) How will you display your documentation?
* inline via comment's only (most stimple, but people would have to read the actual src.
* a dedicated webiste src --> html, host your own api docs site, etc
* Markdown documentation from annotated src (my fav, because you can setup your own really formal docs, or just somethinng quick and dirty" -
have a look at zalando (europes largest online cloathing shop) opensource projects on github. It's documentation is that good that even i as a designer understand it.
https://github.com/zalando
Related Rants
every single fuckening day
How documentation works
I want to get in the habit of proper documentation of my code, But i'm not sure how it's formatted, how it should look or how I should even begin writing documentation? Do I open a document and just take snap shots of my code and explain how it works? I'm a little confused. Do I take pictures of my UI and explain how to use it? Is it like writing a book?
undefined
documentation
noob