Yong Wee - Project Portfolio Page
1. Overview
After 7 weeks of coding and revisions, a group of 5 enthusiastic NUS Computing students, proudly present to you our newest product, in the scope of CS2113T-Software Engineering and Object Oriented Programming module, FLUFFLE!
FLUFFLE is a writer’s swiss army knife of writing tools, idea generation and organisation. While most writing applications provide the user with a GUI, Fluffle provides a CLI interface that is both lightweight and portable. Users can focus on their writing without distractions and can really help advance their writing.
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
Names
feature - In the
Names
feature implemented, implemented randomization, storage, exception handling, addition, deletion, listing, filtering - Implemented
SpellChecker
andDictionary
classes - In the
SpellChecker
feature implemented, implemented storage, parsing, checking spelling
2.2.2 Miscellaneous enhancements
- Enhanced print format for some word-related
help
commands and in-line with the User Guide. - Added JUnit test methods for all classes created. This includes the
Names
class andSpellChecker
class.
2.3 Contributions to documentation
2.3.1 Contributions to Javadoc comments
- Java-doc comments provided for most of the public classes and methods that are implemented.
2.3.2 Contributions to the User Guide
- Added the Starting of the User Guide and the Quick Start of the guide.
- Edited the
help
function based on feedback received - Added the
Names
family of the User Guide - Helped to format document including team members’ part
- Added parts of the Command Summary
- Increased the navigability between sections in the User Guide (added a working Table of Contents, …).
- Proofread User Guide and gave feedback to team members.
2.3.3 Contributions to the Developer Guide
- Added the
Names
class family - Added the overview of Fluffle which was later revised.
- Added Figure 10 UML Class Diagram
2.5 Contributions to team-based tasks
- Setup the team repo as instructed by the details on the module website.
- Provided helpful advice to team members when they asked questions.
- Updated v1.0 and v2.0.
- Reported issues and evaluated team members’ code, helping them to fix their issues if needed.
2.6 Contributions beyond the project team
- Reviewed and gave thoughtful feedback on other team’s Developer Guide.
- Reported bugs for other team’s project.
- Replied and gave suggestions to other teams who seeked clarification from me. here