Welcome to the NeuroSync User Guide!

NeuroSync helps psychiatrists manage patient records and session notes efficiently. Choose a topic below to get step-by-step instructions, troubleshoot issues, and maximize your productivity!

💡 Core Features

• 📁 Manage Patient Records - Add, edit, and delete patient details.
• 📝 Session Notes - Keep track of discussions, diagnoses, and treatments.
• 🔎 Powerful Search & Filters - Quickly retrieve any patient or note.
• ⚡ Command-Based Interface - Fast, efficient, and easy to use.

📜 Table of Contents

1. Introduction
2. Getting Started
3. Core Features
4. Command Summary
5. Commands & Usage
   • Patient Management Commands
     • View All Patients
     • Finding a Patient
     • Adding a Patient
     • Editing a Patient
     • Deleting a Patient
   • Note Management Commands
     • Viewing Notes
     • Filtering Notes
     • Adding a Note
     • Edit a Note
     • Delete a Note
   • General Commands
     • Undo
     • Redo
     • Clear All Data
     • Help
6. FAQs & Troubleshooting
7. Technology Stack
8. Acknowledgemets
9. Contact & Support

📢 Introduction

What does NeuroSync do?

NeuroSync keeps track of patient details and session notes effortlessly. No more searching through paper files—find what you need instantly using powerful search and filter commands.

Why Use NeuroSync?
✅ Fast & Simple - No unnecessary clicks, just type commands.
✅ Powerful Search & Filters - Retrieve patient data in seconds.
✅ Organized & Secure - Keep confidential data well-structured.

🔝 Back to Top

🚀 Getting Started

1️⃣ Download & Install

1. Download the latest release from NeuroSync Releases.
2. Move the downloaded jar file to your preferred folder where you’d like to store your NeuroSync app
3. Check your Java version:

• NeuroSync runs exclusively on Java version 17
• To check your Java version, you can follow this tutorial

1. Open NeuroSync:

• For Windows:
  • Open the folder where NeuroSync is saved
  • Hold shift, right-click in the folder, select “Open Command Window Here”
  • Type the following command and press Enter.

    java -jar NeuroSync.jar
    

    

• For Mac:
  • Press Command (⌘) + Space to open spotlight search, search for Terminal and open it
  • Type cd (followed by a space), then drag and drop the folder where NeuroSync is saved into the Terminal window
  • Press Enter, then type:

    java -jar NeuroSync.jar
    

  • Press Enter

1. You can now use NeuroSync!

2️⃣ System Requirements

• Java: Version 17
• OS Compatibility: Windows, macOS, Linux

🔝 Back to Top

🧭 Command Summary

🔝 Back to Top

🎯 Commands & Usage

Each command is designed to make patient and session management fast and intuitive.

Listing Patients

You can view all patients using the list command!

Example:

list

✔️ Expected Output:

💡 Tip: Use the Find command to quickly locate a patient.

🔝 Back to Top

Finding a Patient

You can find a specific patient by their name, phone number or address, using the find command.

find KEYWORD [MORE_KEYWORDS]

Example:

find yu

✔️ Expected Output:

💡 Tip: Multiple matches may be returned if you use a common name/address/phone number. Use specific names or words to narrow your search.

🔝 Back to Top

Adding a Patient

You can add new patients using their name, phone number, and address.

add n/NAME p/PHONE_NUMBER a/ADDRESS [t/TAG]…​

Example:

add n/John Doe p/98005442 a/123 Clementi Street t/ADHD

✔️ Expected Output:

⚠️ Warning: Duplicate patient names are not allowed, for clarity. (case insensitive)

💡 Tip: Use tags (t/) to categorize patients (e.g., t/Anxiety). Duplicate tags (case-insensitive) will be auto-filtered to only preserve the first instance seen.

💡 Tip: Name Constraints
Names should only contain alphabets, numbers, spaces, and certain special characters ,.'-
Additionally, a s/o or d/o is allowed between names (e.g, Ridwan s/o Mista)
Only one s/o or d/o is allowed in the full name.

💡 Tip: Phone Number Constraints
Phone numbers must consist of only digits, optionally starting with a ‘+’, and be between 3-15 digits long.
This allows you to add patients from multiple countries!

Example:

add n/John Doe p/98005442 a/123 Clementi Street t/ADHD t/adhd t/Anxiety t/ANXIETY

In this example, only the tags ADHD and Anxiety will be preserved.

🔝 Back to Top

Editing a Patient

You can change a patient’s information using the edit command!

edit INDEX [n/NAME] [p/PHONE_NUMBER] [a/ADDRESS] [t/TAG]…​

Example:

edit 1 p/91234567

✔️ Expected Output:

⚠️ Warning: Only update fields that need changing to avoid accidental edits.
💡 Tip: You can edit just one piece of data, e.g, only the phone number.
💡 Tip: You may also use tags (t/) to alphanumerically categorize patients (e.g., t/Anxiety). Duplicate tags (case-insensitive) will be auto-filtered to only preserve the first instance seen.

Example:

add n/John Doe p/98005442 a/123 Clementi Street t/ADHD t/adhd t/Anxiety t/ANXIETY

In this example, only the tags ADHD and Anxiety will be preserved.

🔝 Back to Top

Deleting a Patient

After a patient recovers, you can delete them from NeuroSync using the index number listed next to their name.

📝 Note: Deleting a patient also deletes all of their notes.

delete INDEX

Example:

delete 3

✔️ Expected Output:

💡 Tip: You can undo a delete using the undo command!

🔝 Back to Top

Viewing Notes

To see all notes at a glance!

viewnotes INDEX
viewnotes all

💡 Tip: The viewnotes all command only displays notes from your current patient list panel.

Example:

viewnotes 1

✔️ Expected Output:

⚠️ Warning: If a patient has many notes, it may take a moment to load.
💡 Tip: Use Filter Notes to narrow down results if you have many notes.

🔝 Back to Top

Filtering Notes

To see specific notes for one patient!

filternote INDEX nt/TITLE_KEYWORD

Example:

filternote 1 nt/23

✔️ Expected Output:

💡 Tip: Be specific with keywords to avoid too many results. Keywords should be part of the note’s title for better results.

🔝 Back to Top

Adding a Note

You can add notes to a patient to keep track of discussions, diagnoses, etc.
Duplicate note titles (case-insensitive) are not allowed.

note INDEX nt/TITLE nc/CONTENT

Example:

note 2 nt/Mood Assessment nc/Discussed mood swings and coping strategies.

✔️ Expected Output:

View the changes after:

💡 Tip: Keep notes short and concise, highlighting the most important aspects.

🔝 Back to Top

Editing a Note

You can always make changes to your note content after creating it, using the editnote command!

editnote INDEX nt/TITLE nc/CONTENT

Example:

editnote 2 nt/Mood Assessment nc/Patient showed signs of suicide. Discussed mood swings and coping strategies.

✔️ Expected Output:

View the changes after:

💡 Tip: You can only edit the note content. If you wish to change a note title, you can delete a note and add a new note with the changed title!

🔝 Back to Top

Deleting a Note

If you no longer need a note, you can delete it using the deletenote command.

deletenote INDEX nt/TITLE 

Example:

deletenote 2 nt/Mood Assessment

✔️ Expected Output:

View the changes after:

💡 Tip: You can undo a deletenote using the undo command!

🔝 Back to Top

Undo

If you made a mistake, don’t stress! You can undo your previous change using this command.

Example (following the example in deletenote):

undo

✔️ Expected Output:

View the changes after:

💡 Tip: undo command does not apply to list, find, viewnotes, filternoteand help.

🔝 Back to Top

Redo

If you need to get back a change you undid, don’t stress! You can redo your previous change using this command.

Example (following the example in undo):

redo

✔️ Expected Output:

View the changes after:

🔝 Back to Top

Clear All Data

⚠️ Warning: Use with caution! This will instantly remove all data.

Example:

clear

✔️ Expected Output:

💡 Tip: You can recover your lost data using the undo command.

🔝 Back to Top

Help

Opens a pop-up to give you the link to this User Guide

Example:

help

✔️ Expected Output:

💡 Tip: Use help if you forget a command.

🔝 Back to Top

❓ FAQs & Troubleshooting

Q: Where is my data stored?
A: Your data is saved in addressbook.json inside the /data folder.
⚠️ Warning: Please do not modify addressbook.json as there could be unpredictable effects.

Q: Can I undo a deletion?
A: Yes! There is an undo feature, to recover data or undo edits.

Q: How do I transfer data to another device?
A: Copy the addressbook.json file from /data and paste it into the same directory on the new device.

Q: How many patients does NeuroSync Support??
A: 999999999, if more are added, unexpected behaviour may happen.

Q: Can I use languages other than English?
A: As of now, NeuroSync only has full support for English. Using other languages is not totally disallowed, but may cause unintended behaviours. Do keep a lookout for future releases supporting more languages!

🔝 Back to Top

🙌 Acknowledgements

This project is based on the AddressBook-Level3 project by the SE-EDU initiative.

Visit se-education.org for more open-source CS education projects.

📬 Contact & Support

For issues and contributions, please raise an issue or pull request in the GitHub repository.

🔝 Back to Top

🚀 Enjoy using NeuroSync!