IMPROVING YOUR DEVELOPMENT DOCUMENTATION PROJECT by Javier Hernández

PART 1

What this article covers:

First steps on how to improve an existing documentation project.

Tools:

Confluence, GitHub web and desktop versions, and MarkdownPad2.

INTRODUCTION

Developer Documentation is a curated set of files?describing all the active?workflows,?setups,?tools,?conventions,?best practices, and?How-tos?of your software development product. Through this article, I will refer to it as “documentation” or “docs”.

Documentation supports your team members in their daily and future developments. It also helps new joiners to reach cruise speed during the onboarding period.?But to do so, your documentation must be up-to-date and well-structured.

Keeping the docs up-to-date and in good shape requires resources and dedicated time. Yet often our project time or budget constraints prevent us from taking care of our docs properly.

This series of articles aims to serve as a documentation improvement guide.

(...)

See the full article here: https://mb4.me/q9sqFib7