Skip to content
This repository has been archived by the owner on Jun 29, 2020. It is now read-only.

Commit

Permalink
Make docs more descriptive.
Browse files Browse the repository at this point in the history
  • Loading branch information
critical-path committed Sep 22, 2019
1 parent ac06a4f commit d12e1d4
Show file tree
Hide file tree
Showing 2 changed files with 152 additions and 6 deletions.
79 changes: 76 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,90 @@ To start stakeholders, run the following commands from your shell.
Using stakeholders
==================

Using stakeholders is easy!

View home page
--------------

Point your browser to any of the following URLs.

* :code:`http://localhost:8080/`
* :code:`http://localhost:8080/home`
* :code:`http://localhost:8080/index`

Then, add one or more stakeholders.
Add stakeholders
----------------

In the navbar, select :code:`stakeholders` and then :code:`add`.

Use the form to identify and evaluate a stakeholder. Enter the stakeholder's name, role, sentiment toward your project, level of power, and level of interest in your project. Then click on the :code:`add` button.

Repeat this process as many times as necessary.

Show stakeholders
-----------------

In the navbar, select :code:`stakeholders` and then :code:`show/update/delete`.

Your stakeholders appear here, sorted by their unique identifiers. Each stakeholder has a management approach, which is a function of that stakeholder's levels of power and interest.

=============== ======= ======== ======
Approach Power Interest Flag
=============== ======= ======== ======
Monitor closely high high red
Keep satisfied high low orange
Keep informed low high green
Monitor low low blue
Unknown invalid invalid gray
=============== ======= ======== ======

Add deliverables
----------------

In the navbar, select :code:`deliverables` and then :code:`add`.

Use the form to identify a deliverable, where a deliverable is a reporting requirement. Enter the deliverable's name, kind (type), medium, level of formality, and frequency. Then click on the :code:`add` button.

Repeat this process as many times as necessary.

Show deliverables
-----------------

In the navbar, select :code:`deliverables` and then :code:`show/update/delete`.

Your deliverables appear here, sorted by their unique identifiers.

Add associations
----------------

In the navbar, select :code:`associations` and then :code:`add`.

Use the form to identify an association, where an association is the assignment of a deliverable to a stakeholder. Enter a stakeholder and a deliverable appropriate for that stakeholder. Then click on the :code:`add` button.

Repeat this process as many times as necessary. (It is possible to assign multiple deliverables to the same stakeholder as well as to assign the same deliverable to multiple stakeholders.)

Show associations
-----------------

In the navbar, select :code:`associations` and then :code:`show/update/delete`.

Your associations appear here, sorted by their unique identifiers.

View management plan
--------------------

In the navbar, select :code:`management-plan`.

Your associations appear here, sorted first by management approach, then by stakeholders' unique identifiers, and then by deliverables' unique identifiers.

This is your stakeholder management - the whole purpose of this app!

Make updates
------------

Next, add one or more deliverables.
In the navbar, select either :code:`stakeholders`, :code:`deliverables`, or :code:`associations` and then :code:`show/update/delete`.

Finally, add one or more associations between stakeholders and deliverables. This will add content to your stakeholder management plan.
Find a stakeholder, deliverable, or association and then click on its :code:`update` or :code:`delete` button.


Notes on stakeholders
Expand Down
79 changes: 76 additions & 3 deletions docs/use.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,87 @@
Using stakeholders
==================

Using stakeholders is easy!

View home page
--------------

Point your browser to any of the following URLs.

* :code:`http://localhost:8080/`
* :code:`http://localhost:8080/home`
* :code:`http://localhost:8080/index`

Then, add one or more stakeholders.
Add stakeholders
----------------

In the navbar, select :code:`stakeholders` and then :code:`add`.

Use the form to identify and evaluate a stakeholder. Enter the stakeholder's name, role, sentiment toward your project, level of power, and level of interest in your project. Then click on the :code:`add` button.

Repeat this process as many times as necessary.

Show stakeholders
-----------------

In the navbar, select :code:`stakeholders` and then :code:`show/update/delete`.

Your stakeholders appear here, sorted by their unique identifiers. Each stakeholder has a management approach, which is a function of that stakeholder's levels of power and interest.

=============== ======= ======== ======
Approach Power Interest Flag
=============== ======= ======== ======
Monitor closely high high red
Keep satisfied high low orange
Keep informed low high green
Monitor low low blue
Unknown invalid invalid gray
=============== ======= ======== ======

Add deliverables
----------------

In the navbar, select :code:`deliverables` and then :code:`add`.

Use the form to identify a deliverable, where a deliverable is a reporting requirement. Enter the deliverable's name, kind (type), medium, level of formality, and frequency. Then click on the :code:`add` button.

Repeat this process as many times as necessary.

Show deliverables
-----------------

In the navbar, select :code:`deliverables` and then :code:`show/update/delete`.

Your deliverables appear here, sorted by their unique identifiers.

Add associations
----------------

In the navbar, select :code:`associations` and then :code:`add`.

Use the form to identify an association, where an association is the assignment of a deliverable to a stakeholder. Enter a stakeholder and a deliverable appropriate for that stakeholder. Then click on the :code:`add` button.

Repeat this process as many times as necessary. (It is possible to assign multiple deliverables to the same stakeholder as well as to assign the same deliverable to multiple stakeholders.)

Show associations
-----------------

In the navbar, select :code:`associations` and then :code:`show/update/delete`.

Your associations appear here, sorted by their unique identifiers.

View management plan
--------------------

In the navbar, select :code:`management-plan`.

Your associations appear here, sorted first by management approach, then by stakeholders' unique identifiers, and then by deliverables' unique identifiers.

This is your stakeholder management - the whole purpose of this app!

Make updates
------------

Next, add one or more deliverables.
In the navbar, select either :code:`stakeholders`, :code:`deliverables`, or :code:`associations` and then :code:`show/update/delete`.

Finally, add one or more associations between stakeholders and deliverables. This will add content to your stakeholder management plan.
Find a stakeholder, deliverable, or association and then click on its :code:`update` or :code:`delete` button.

0 comments on commit d12e1d4

Please sign in to comment.