#18278: Set a standard for pluggable end user documentation
-------------------------------+---------------------------
Reporter: sbaechler | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords: documentation
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+---------------------------
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/18278>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
