Documentation driven development

ShalokShalom · May 17, 2019, 10:37am

Given my current experience with this project, I highly recommend reading this document:

gist.github.com

https://gist.github.com/zsup/9434452

ddd.md

### Documentation-Driven Development

The philosophy behind Documentation-Driven Development is a simple: **from the perspective of a user, if a feature is not documented, then it doesn't exist, and if a feature is documented incorrectly, then it's broken.**

- Document the feature *first*. Figure out how you're going to describe the feature to users; if it's not documented, it doesn't exist. Documentation is the best way to define a feature in a user's eyes.
- Whenever possible, documentation should be reviewed by users (community or Spark Elite) before any development begins.
- Once documentation has been written, development should commence, and test-driven development is preferred.
- Unit tests should be written that test the features as described by the documentation. If the functionality ever comes out of alignment with the documentation, tests should fail.
- When a feature is being modified, it should be modified documentation-first.
- When documentation is modified, so should be the tests.

This file has been truncated. show original

I enjoy it and I think it is valuable for every developer.

Topic	Replies	Views
Documentation functionality in GITLAB How to Use GitLab	472	March 28, 2023
How The Good Docs Project uses GitLab for documentation as code and more Community	408	July 6, 2023
Coordinating major documentation projects with GitLab Community	406	August 24, 2023
Five fast facts about docs as code at GitLab Community	402	October 12, 2022
Video interview with The Good Docs Project GitLab for Open Source	588	June 5, 2023

Documentation driven development

Related topics