Create Intended Audience Section for documentation #5401
Conversation
for more information, see https://pre-commit.ci
| ## Table of Contents | ||
|
|
||
| - [IntendedAudience](#IntendedAudience) | ||
| - [Features](#Features) |
There was a problem hiding this comment.
## Optional Integrations is missing
There was a problem hiding this comment.
A ToC would be a good addition!
| - [Releases](#Releases) | ||
| - [Articles](#Articles) | ||
|
|
||
| ## IntendedAudience |
| beforehand, thus preventing missing dependencies later on in the development process. | ||
|
|
||
| Users of this software should have working proficiency in building django applications. For new users to Django, please | ||
| refer to the official documentation: [here](https://docs.djangoproject.com/en/5.1/) |
There was a problem hiding this comment.
Do not link to a version here, otherwise it will be out of sync in no time when we forget to update the corresponding version. If you want to link to a version: we are at 5.0 at the time.
| ## IntendedAudience | ||
|
|
||
| The purpose of this section is to outline the prerequisite knowledge that potential users need to effectively create projects | ||
| with this application. Links will be provided to supplemental resources to help users get up to speed. |
There was a problem hiding this comment.
You are reading a readme, not a 300 pager. So the introduction is way to long and, in my opinoin, unnecessary.
| - postgresql version | ||
| See the [Usage](#Usage) section for a clear guide to the project creation process. | ||
|
|
||
| For more information about these specific requirements, see the documentation provided: |
There was a problem hiding this comment.
Do people really benefit from linking to these sources?
| To use this application most effectively, users should have the scope of their application defined before beginning to create | ||
| a new project. | ||
|
|
||
| Example's of defined scope include: |
There was a problem hiding this comment.
What means an example of defined scope?
You are trying to say that you need prior knowledge of docker etc right?
| with this application. Links will be provided to supplemental resources to help users get up to speed. | ||
|
|
||
| This application's main purpose is to increase the efficiency of django applications by defining project specifications | ||
| beforehand, thus preventing missing dependencies later on in the development process. |
There was a problem hiding this comment.
This sentence outlines the intended audience nicely 👍
Description
I am proposing the addition of an intended audience section for the official README of this application.
Rationale
The purpose of the intended audience section is to allow potential users to quickly scan to see if this application is well suited for their needs/experience level. When going through the official documentation for this project, I struggled to understand the use cases for some of the prompts requested when initializing the template. If users want the most out of using this application, it would make sense that they need prerequisite knowledge of what each prompted user input allows the project to accomplish, as this would save them time when configuring their project - which aligns nicely with the goal of the application as a whole.