DEV Community

Der Sascha
Der Sascha

Posted on

2

Where do you keep your technical documentation?

I wonder where you all keep your technical (or maybe your project) documentation. Do you write it down in Word, Excel or s.th.? Or do you use other tools for it?.

Let me know! :)

Top comments (5)

Collapse
 
thomasthespacefox profile image
Thomas Leathers

Well, Over at the SBTCVM project (a Project that develops a Balanced ternary virtual machine and related tools, utilities, etc.), we have an extensive users manual in both pdf and odt formats that provides the bulk of "polished" technical documentation, while we also have a directory full of .txt developer's notes, that are about as technical as one may expect such notes for a Balanced Ternary Virtual Machine and accompanying utilities and libraries would be...

Collapse
 
jess profile image
Jess Lee

We've been keeping our technical documentation in a github wiki. Here's a bunch of documentation examples that people seem to be a fan of: dev.to/ben/what-are-some-examples-...

Collapse
 
d4be4st profile image
štef

We keep them in a github repo:

github.com/infinum/rails-handbook/

Collapse
 
ben profile image
Ben Halpern

This looks great.

Collapse
 
xephon2 profile image
Stefan Eike

It's quite complex, therefore DITA-XML based, kept in Bitbucket and published by Jenkins.

Billboard image

The Next Generation Developer Platform

Coherence is the first Platform-as-a-Service you can control. Unlike "black-box" platforms that are opinionated about the infra you can deploy, Coherence is powered by CNC, the open-source IaC framework, which offers limitless customization.

Learn more