Vo Quang Hung - Project Portfolio Page
1. Overview
Fluffle is a desktop app for creative writers, optimized for use via a Command Line Interface (CLI). It aids users in creating and managing their writings and ideas. As a fast-typing writer, this CLI app is highly suitable for you. This product is created on IntelliJ IDE with Java programming language.
The latest release of Fluffle can be accessed from here.
2. Summary of Contributions
2.1 Code contributed
- The functional and test code contributed can be accessed via here.
2.2 Enhancement Implemented
2.2.1 Main features enhancements
- Implemented storage for words by
WordsLoader
andWordsSaver
classes. #204 - Implemented
filter words
andlist filter words
commands. #133 #174 - Implemented
remind
command for writings. #214
2.2.2 Miscellaneous enhancements
- Fixed print format for
noun
,verb
andadjective
commands. #293 - Enhanced print format for some word-related
help
commands and made them in sync with the User Guide. #306 - Added JUnit test methods for filter-words-related classes. #150
2.3 Contributions to documentation
2.3.1 Contributions to Javadoc comments
Java-doc comments are provided for most of the public classes and methods that I implemented. This helps subsequent developers to catch up with the project easily.
2.3.2 Contributions to the User Guide
- Added the Preface and Command format sections for Feature section.
- Added “Filtering words in word list:
filter word
” and “Listing your filter list:list filter words
” sections. - Added “Getting reminders for your writings scheduled for a specific date:
remind
” section. - Increased the navigability between sections in the User Guide (add Table of Contents, Jump to top, …).
- Proofread User Guide and gave feedback to team members.
2.3.3 Contributions to the Developer Guide
- Provided the skeleton for the whole document (headings, subheadings, etc…) #309
- Added “Introduction/Background” section and modified “Setting up the project in your computer” section.
- Added “Design/Architecture” section together with “Figure 1: Overview of Fluffle Architecture”.
- Added “Implementation/Writing Features/Getting reminder for writings scheduled on a specific date” section.
- Added “Implementation/Word Features/Filtering words” section together with Figure 6 and Figure 7.
- Added v2.0 entries in “Appendix C: User Stories” table.
- Added Appendix D and Appendix E.
2.4 Contributions to team-based tasks
- Setup the team repo as instructed by the details on the module website.
- Kept an eye on the module’s requirements and reminded team members to finish their tasks and got credit on the tP progress dashboard.
- Assigned team members to their issues.
- Released v1.0 and v2.0. v1.0 v2.0
- Reported issues and evaluated team members’ code, sometimes helped them fix the issues, too. #187 #223 #274
- Refactored the packages to be more OOP. #315