diff --git a/source/introduction/research.rst b/source/introduction/research.rst --- a/source/introduction/research.rst +++ b/source/introduction/research.rst @@ -1,8 +1,8 @@ Project User Research Profile ============================= -Short summary description of the purpose of the application, who it is -for, and what those people can do with it. +Create a short summary of the purpose of your application: who it is +for, and what people can do with it. Purpose ======= @@ -14,18 +14,20 @@ details in the lower sections may take some work and discussion within the project to complete. -Who is the application for? +Who is the Application for? --------------------------- -- List of types (groups) of users -- User groups can be organized based on any type of dimension -- Some groups may be broken down in to sub groups +- List types (groups) of users +- Organize user groups based on any type of dimension +- Some groups may be further broken down in to subgroups (Who is the application *not* for) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- Sometimes it is easy to identify who the application is **not** for -- This can help keep the scope of the project under control +Sometimes it is easier to identify who the application is **not** for. This can +help keep the scope of the project under control. +You are able to set boundaries or parameters within which your application +should work. Sample User Profiles ~~~~~~~~~~~~~~~~~~~~ @@ -35,45 +37,43 @@ description of that user's characteristics based on a real user you know. -What kinds of tasks will they complete --------------------------------------- +What kinds of tasks will they complete? +--------------------------------------- - List of common tasks users will complete -- This does not have to be a complete functional specification, but - major tasks and specialty tasks should be listed -- Include functionality that is planned but not yet implemented to help - keep the future in focus +- Detail major tasks and specialty tasks +- Include tasks that are planned but not yet implemented to keep a line of work +in future implementations -(What kinds of functionality will the application *not* support) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +(What kinds of functionality will the application *not* support?) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - List tasks or functionality the application will not address -- Sometimes it is useful to list this unintended functionality to help - keep the scope of the application -- For example, a certain functionality may not be implemented because - it is out of scope with the primary goals of the project, another - application with a different focus does it better, or it is an - extreme edge case for a user type which is not primary +- List this unintended functionality to help keep the scope of the application. + - For example, a certain functionality may not be implemented because it is out + of the scope of the primary project goals. Perhaps another application, with a + different focus, does it better, or it is an extreme edge case for a + non-primary user. -Sample Use Scenarios and Cases -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Sample Use Scenarios and Cases** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Use Scenario 1: For each task identified (or major tasks, or +* **Use Scenario 1**: For each task identified (or major tasks, or particularly special tasks if many tasks are defined), write a description of how that user would accomplish the task *independent* of how they would complete it within the application. -Use Case 1: If a use scenario has been implemented, include a matching -use case which describes how the task use scenario can be completed in -the application. There may be branching or multiple ways to complete the +* **Use Case 1**: If a use scenario has already been implemented, include a +matching use case that describes how the task use scenario can be completed in +the application. There may multiple ways to complete the same task, and this is a good way to document it. -Environment Conditions & Requirements -------------------------------------- +Environmental Conditions & Requirements +--------------------------------------- - List of environmental conditions for the user or the application to consider -- For example, an Internet-capable application would require an + - For example, an Internet-capable application would require an Internet connection More Information @@ -89,7 +89,7 @@ Still Need Help? ---------------- -CFor more information and help you can find us on -`Matrix `_, -`IRC `_ or -`Telegram `_ \ No newline at end of file +CFor more information and help you can find us on +`Matrix `_, +`IRC `_ or +`Telegram `_