# Help us improve the Open edX developer docs! **URL:** \ **Category:** Development\ **Tags:** how-to\ **Created:** [January 8, 2021, 3:46pm UTC](https://discuss.openedx.org/t/help-us-improve-the-open-edx-developer-docs/3975 "2021-01-08T15:46:08Z")\ **Posts on this page:** 8\ **Page:** 1
**Author:** ![amy.e.brown](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/amy.e.brown/32/1966_2.png) [@amy.e.brown](https://discuss.openedx.org/u/amy.e.brown)\ **Post date:** [January 8, 2021, 3:46pm UTC](https://discuss.openedx.org/t/help-us-improve-the-open-edx-developer-docs/3975/1 "2021-01-08T15:46:08Z")
Good day everyone! We’re looking for your input on **improving** the Open edX **developer documentation**. Your responses to this brief **survey** will help us greatly. [https://forms.gle/T2JS9enCEk5QkJHR9](https://forms.gle/T2JS9enCEk5QkJHR9) Responses received by next Tuesday evening will be given the most weight. So if you feel strongly about the developer documentation, please answer promptly. Thanks! ---
**Author:** ![nedbat](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/nedbat/32/3317_2.png) [@nedbat](https://discuss.openedx.org/u/nedbat)\ **Post date:** [January 8, 2021, 5:09pm UTC](https://discuss.openedx.org/t/help-us-improve-the-open-edx-developer-docs/3975/2 "2021-01-08T17:09:06Z")
---
**Author:** ![nedbat](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/nedbat/32/3317_2.png) [@nedbat](https://discuss.openedx.org/u/nedbat)\ **Post date:** [January 8, 2021, 5:09pm UTC](https://discuss.openedx.org/t/help-us-improve-the-open-edx-developer-docs/3975/3 "2021-01-08T17:09:43Z")
---
**Author:** ![nedbat](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/nedbat/32/3317_2.png) [@nedbat](https://discuss.openedx.org/u/nedbat)\ **Post date:** [January 8, 2021, 5:09pm UTC](https://discuss.openedx.org/t/help-us-improve-the-open-edx-developer-docs/3975/4 "2021-01-08T17:09:47Z")
---
**Author:** ![nedbat](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/nedbat/32/3317_2.png) [@nedbat](https://discuss.openedx.org/u/nedbat)\ **Post date:** [January 13, 2021, 3:17pm UTC](https://discuss.openedx.org/t/help-us-improve-the-open-edx-developer-docs/3975/5 "2021-01-13T15:17:32Z")
---
**Author:** ![braden](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/braden/32/46_2.png) [@braden](https://discuss.openedx.org/u/braden)\ **Post date:** [January 15, 2021, 11:45pm UTC](https://discuss.openedx.org/t/help-us-improve-the-open-edx-developer-docs/3975/6 "2021-01-15T23:45:56Z")
Thanks! I’m happy to hear about this initiative. I was a bit surprised that there were no questions about: where people look for documentation, where people expect to find documentation, API documentation in general, documentation format in general, nor how documentation should be maintained. Personally what I would like to see (in the long term, not necessarily in the next six months) is a focus on systematic reference documentation. i.e. things like: every repository should have a README that clearly explains the “what” and the “why”; every API should have a description and a usage example; every setting and feature flag should have a description; every plugin/integration point should be documented with an example, and so on. Django is an example of a project that does this well. ---
**Author:** ![nimisha](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/nimisha/32/1511_2.png) [@nimisha](https://discuss.openedx.org/u/nimisha)\ **Post date:** [March 29, 2021, 12:02am UTC](https://discuss.openedx.org/t/help-us-improve-the-open-edx-developer-docs/3975/7 "2021-03-29T00:02:04Z")
Thanks to all who contributed their thoughts and experiences on the Open edX Developer documentation and training survey. We have compiled the results and shared them at [Developer Documentation and Training Survey Results - 2021-Jan](https://openedx.atlassian.net/wiki/spaces/AC/pages/2445476472/Developer+Documentation+and+Training+Survey+Results+-+2021-Jan). ---
**Author:** ![nimisha](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/nimisha/32/1511_2.png) [@nimisha](https://discuss.openedx.org/u/nimisha)\ **Post date:** [March 29, 2021, 12:19am UTC](https://discuss.openedx.org/t/help-us-improve-the-open-edx-developer-docs/3975/8 "2021-03-29T00:19:58Z")
@braden I agree that the discovery and standardization of documentation is a big gap in the platform. Regarding standardization, we have made some recent progress. - We have [taken strides](https://openedx.atlassian.net/wiki/spaces/COMM/pages/1596358943/BD-21+Toggles+Settings+Documentation) in providing a standard framework for annotating settings and feature flags, invested in a [doc-a-thon](https://openedx.atlassian.net/wiki/spaces/AC/pages/2248409171/Toggles+and+Settings+Doc-a-thon+2021) to get us started on using it, which now results in [reference documentation](https://edx.readthedocs.io/projects/edx-platform-technical/en/latest/). - We now have a [repo-health check](https://github.com/edx/edx-repo-health/blob/master/repo_health/check_readme.py) that verifies the existence of README files in each of our repos, with some minimal quality checks. - We have rolled out [conventional commits](https://open-edx-proposals.readthedocs.io/en/latest/oep-0051-bp-conventional-commits.html) as a standard to document code changes. My hypothesis with this effort is that it will provide more rigor in our documentation efforts at every code change. Having said this, I know there is still a lot more to do. I’m looking forward to working with you all to make it happen. Regarding documentation discovery, I’d like for us to make a few critical decisions on this so we can move forward with a strategy.