How do you document your code?

Jakob Christensen - Apr 6 '18 - - Dev Community

I am sure this has been discussed before but I am looking for suggestions on how to keep our documentation at work, that is suggestions on tooling. The documentation will be on code, deployment, and how to get started for newcomers. It will also contain mathematical documentation on the business logic.

I have a few requirements for the documentation tool:

  • It must be private to our company.
  • Writing must be easy, i.e. available to non-developers.
  • It is preferrably web-based (either hosted or on-premise).
  • It must support math notation and code color syntaks.
  • Single sign-on (Windows domain) is a plus but not a must.

Our code resides on an on-premise classic TFS server but our developers are familiar with Git. The non-developers are not familiar with code repos.

Markdown is a good option but it does have some short-comings. I have used GitBooks myself but I think it is really easy to mess up when linking. At work we have Sharepoint but Sharepoint wikis are just... awful 😒

So, any suggestions are very much appreciated 😊

. . . . . . . . . . . . . . . . . . . . . . . . . . . .
Terabox Video Player