Skip to content

Commit 12987cd

Browse files
committed
Added tutorials back.
1 parent 8041ccd commit 12987cd

File tree

4 files changed

+872
-0
lines changed

4 files changed

+872
-0
lines changed

docs/team/johndoe.adoc

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
= John Doe - Project Portfolio
2+
:site-section: AboutUs
3+
:imagesDir: ../images
4+
:stylesDir: ../stylesheets
5+
6+
== PROJECT: AddressBook - Level 3
7+
8+
---
9+
10+
== Overview
11+
12+
AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
13+
14+
== Summary of contributions
15+
16+
* *Major enhancement*: added *the ability to undo/redo previous commands*
17+
** What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
18+
** Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
19+
** Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
20+
** Credits: _{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}_
21+
22+
* *Minor enhancement*: added a history command that allows the user to navigate to previous commands using up/down keys.
23+
24+
* *Code contributed*: [https://github.com[Functional code]] [https://github.com[Test code]] _{give links to collated code files}_
25+
26+
* *Other contributions*:
27+
28+
** Project management:
29+
*** Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
30+
** Enhancements to existing features:
31+
*** Updated the GUI color scheme (Pull requests https://github.com[#33], https://github.com[#34])
32+
*** Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests https://github.com[#36], https://github.com[#38])
33+
** Documentation:
34+
*** Did cosmetic tweaks to existing contents of the User Guide: https://github.com[#14]
35+
** Community:
36+
*** PRs reviewed (with non-trivial review comments): https://github.com[#12], https://github.com[#32], https://github.com[#19], https://github.com[#42]
37+
*** Contributed to forum discussions (examples: https://github.com[1], https://github.com[2], https://github.com[3], https://github.com[4])
38+
*** Reported bugs and suggestions for other teams in the class (examples: https://github.com[1], https://github.com[2], https://github.com[3])
39+
*** Some parts of the history feature I added was adopted by several other class mates (https://github.com[1], https://github.com[2])
40+
** Tools:
41+
*** Integrated a third party library (Natty) to the project (https://github.com[#42])
42+
*** Integrated a new Github plugin (CircleCI) to the team repo
43+
44+
_{you can add/remove categories in the list above}_
45+
46+
== Contributions to the User Guide
47+
48+
49+
|===
50+
|_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._
51+
|===
52+
53+
include::../UserGuide.adoc[tag=delete]
54+
55+
include::../UserGuide.adoc[tag=dataencryption]
56+
57+
== Contributions to the Developer Guide
58+
59+
|===
60+
|_Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project._
61+
|===
62+
63+
include::../DeveloperGuide.adoc[tag=undoredo]
64+
65+
include::../DeveloperGuide.adoc[tag=dataencryption]
66+
67+
68+
== PROJECT: PowerPointLabs
69+
70+
---
71+
72+
_{Optionally, you may include other projects in your portfolio.}_

0 commit comments

Comments
 (0)