Opened 3 years ago

Closed 3 years ago

#18278 closed New feature (wontfix)

Set a standard for pluggable end user documentation

Reported by: sbaechler Owned by: nobody
Component: Documentation Version: master
Severity: Normal Keywords: documentation
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


The average Django project consists of the base Django installation, a few custom apps and a few 3rd party apps. While the developer documentation for most of those apps is good enough, the end user docs (for people who fill in the content) is not. We usually have to write it up from scratch for every single new website.

It would be great if Django offered a system similar to admindocs that would spit out a end user documentation for all installed apps. Or at least a base that the project managers could use to work off from.

This would mean setting standards for the following points:

  • The format used for the documentation (rst, html)
  • The folder structure, location and naming
  • Support for multiple languages and other requirements
  • The structure of the documentation itself so it can be added to the main documentation.

If the documetation was bundled with the app, the quality of it would improve over time because everyone would be using it.
You could save a lot of development time because the project managers and developers don't have to copy text from all over the web.

Change History (1)

comment:1 Changed 3 years ago by lukeplant

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Resolution set to wontfix
  • Status changed from new to closed

This sounds to me like something that can be implemented as a standalone app, just as admindocs could be standalone. If such an app is created and gets support (i.e. actual projects using it), and, additionally, it becomes evident that it would benefit from being a contrib app rather than 3rd party, then it can be added to contrib. Until then I'm closing this as out of scope.

Note: See TracTickets for help on using tickets.
Back to Top