Skip to content

Commit

Permalink
DeveloperGuide: mark appendices as [appendix]
Browse files Browse the repository at this point in the history
This makes asciidoctor automatically number them as Appendix A, B, C...
which is better than having it maintain the numbering ourselves.
  • Loading branch information
pyokagan committed Jul 4, 2018
1 parent da9fc33 commit da519a9
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ image::mainClassDiagram.png[]

* In IntelliJ, right-click on the `test` folder and choose `Run 'All Tests'`

== Appendix A : User Stories
[appendix]
== User Stories

Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`

Expand All @@ -60,7 +61,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
|`*` |user with many persons in the address book |sort persons by name |locate a person easily
|===========================================================================================================================================

== Appendix B : Use Cases
[appendix]
== Use Cases

(For all use cases below, the *System* is the `AddressBook` and the *Actor* is the `user`, unless specified otherwise)

Expand All @@ -86,14 +88,16 @@ Use case ends.
+
Use case resumes at step 2.

== Appendix C : Non Functional Requirements
[appendix]
== Non Functional Requirements

. Should work on any <<mainstream-os, mainstream OS>> as long as it has Java 8 or higher installed.
. Should be able to hold up to 1000 persons.
. Should come with automated unit tests and open source code.
. Should favor DOS style commands over Unix-style commands.

== Appendix D : Glossary
[appendix]
== Glossary

[[mainstream-os]] Mainstream OS::
Windows, Linux, Unix, OS-X
Expand Down

0 comments on commit da519a9

Please sign in to comment.