Journal
2019 IEEE INTERNATIONAL PROFESSIONAL COMMUNICATION CONFERENCE (PROCOMM)
Volume -, Issue -, Pages 255-256Publisher
IEEE
DOI: 10.1109/ProComm.2019.00054
Keywords
Docs like code; GitHub; Markdown; PingCAP
Ask authors/readers for more resources
In recent years, many open source startups have been adopting a new documentation development solution - GitHub plus Markdown. It's an agile 'Docs Like Code' solution that keeps documents close to the code and applies software development tools and techniques to documentation. Although this open source documentation solution is typically adopted by open source startups or projects, it also applies to any other kind of company as long as you want to make your documentation public to users or customers. This abstract aims to introduce this new choice of documentation solution by elaborating on its practice at an open source startup called PingCAP, so as to promote its adoption in the technical communication field.
Authors
I am an author on this paper
Click your name to claim this paper and add it to your profile.
Reviews
Recommended
No Data Available