Skip to content

Commit 4498a98

Browse files
committed
user guide
1 parent 29bacec commit 4498a98

File tree

9 files changed

+42
-10
lines changed

9 files changed

+42
-10
lines changed

docs/comfortaccounting/user-guide/account-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ card: "article"
1010

1111
---
1212

13-
# Comfort Accounting User Guide
13+
# Account Manager
1414

1515
The Account Manager serves as the core feature for managing financial accounts within the system, offering a straightforward structure for efficient account management.
1616

docs/comfortaccounting/user-guide/agency-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ card: "article"
1010

1111
---
1212

13-
# Comfort Accounting User Guide
13+
# Agency Manager
1414

1515
The Agency Manager serves as the foundational component of the Comfort Accounting system, acting as the **entry point** for all operations and integrations within the platform. It ensures that every action and component is systematically organized and associated with specific agencies, providing a streamlined approach to accounting management.
1616

docs/comfortaccounting/user-guide/category-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ card: "article"
1010

1111
---
1212

13-
# Comfort Accounting User Guide
13+
# Category Manager
1414

1515
The Category Manager is designed to streamline the management of financial categories within the system, enabling clear organization and classification of transactions.
1616

docs/comfortaccounting/user-guide/general.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Both export features are accessible only with the Reports Pro Addon, unlocking p
5353
<br/> This summary provides a high-level view of the plugin's capabilities. For detailed guidance, explore the corresponding sections linked below.
5454

5555
## Components we have ##
56+
[Dashboard](./dashboard.md)\
5657
[Agency Manager](./agency-manager.md)\
5758
[Account Manager](./account-manager.md)\
5859
[Category Manager](./category-manager.md)\

docs/comfortaccounting/user-guide/log-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ card: "article"
1010

1111
---
1212

13-
# Comfort Accounting User Guide
13+
# Log Manager
1414

1515
The Log Manager is designed to capture and record financial data generated from accounts, categories, and the vendor/client (VC) manager. It consolidates various data points into a log entry, allowing for efficient tracking and reporting of financial transactions.
1616

docs/comfortaccounting/user-guide/reports-manager.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,25 @@ card: "article"
1010

1111
---
1212

13-
# Comfort Accounting User Guide
13+
# Reports Manager
1414

15-
Welcome to the Comfort Accounting Reports Manager.
15+
The Reports Manager serves as a **pro feature** of the system, allowing users to generate and manage various financial reports. Currently, the Report Manager includes a **Summary Statement report**, which provides an overview of system entries over a specified date range. This feature plays a critical role in summarizing and analyzing financial data, making it a vital tool for users.
1616

17+
## Summary Statement Report ##
1718

19+
**Report Generation**:
20+
+ The Summary Statement report generates a summary of all system entries within a user-defined date range. Users can specify the start and end dates, allowing for customizable reporting periods. This report offers a comprehensive snapshot of financial **transactions and balances** within the selected timeframe.
21+
22+
**Export Options**:
23+
+ The Summary Statement report can be exported in **various formats** for further analysis and documentation. Supported export formats includes XLS, XLSX, ODS, PDF. This flexibility ensures compatibility with common office software, enabling users to work with the report data in the format they prefer.
24+
25+
**Export & Mail Feature**:
26+
+ The Export & Mail feature is a unique functionality that allows users to generate the report and automatically **send it via email** to the person who triggered the report generation. This feature enhances workflow efficiency by ensuring that the relevant stakeholders are promptly notified and receive the necessary documentation directly in their inbox.
27+
28+
**Edit and Save Options**:
29+
+ From the edit panel, users can update the Summary Statement report if adjustments are needed. Additionally, there is an option to save the **report as new**, allowing users to preserve different versions of the report with custom configurations or date ranges.
30+
31+
## Future Report Additions ##
32+
In the future, the Report Component will be enriched with additional report types to further enhance the capabilities of the accounting plugin. These new reports will offer expanded functionality and address diverse reporting needs, ensuring that users have access to comprehensive financial insights.
33+
34+
The Report Component is a fundamental feature of the accounting plugin, providing powerful reporting capabilities that are essential for business operations. Its flexibility, ease of use, and future expansion make it an indispensable tool for managing and analyzing financial data.

docs/comfortaccounting/user-guide/settings-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ card: "article"
1010

1111
---
1212

13-
# Comfort Accounting User Guide
13+
# Settings Manager
1414

1515
This short guide provides a basic walkthrough for setting up the Comfort Accounting plugin. For detailed instructions on each component, refer to the specific sections in the plugin documentation.
1616

docs/comfortaccounting/user-guide/tools-manager.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,22 @@ card: "article"
1010

1111
---
1212

13-
# Comfort Accounting User Guide
13+
# Tools Manager
14+
15+
The Tools Manager provides essential utilities for managing **system data** and configurations within the platform. It offers three powerful features to enhance data management and ensure smooth operations. These tools help users maintain the integrity of their system, migrate data, and fix orphaned data associations.
16+
17+
## Options ##
18+
19+
**Reset Option Data**:
20+
+ The Reset Option Data feature allows users to **reset specific option** data within the system. Users can view the available options and choose which one to reset. This feature ensures that users can easily clear outdated or incorrect option data, restoring the system to its default or desired state.
21+
22+
**Migration Files**:
23+
+ The Migration Files feature provides users with visibility into which migration files have been successfully migrated and which have not. Users can also initiate **migrations directly** from this section, allowing for streamlined data transfer and system updates. This functionality is crucial for maintaining data consistency during system upgrades or migrations.
24+
25+
**Orphan Data Fixer**:
26+
+ The Orphan Data Fixer helps identify entries that are not properly associated with an agency, classifying them as orphaned data. The tool allows users to associate these orphaned entries with a **specified agency id**, ensuring that all data is correctly linked and no records are left unassociated. This feature is critical for maintaining accurate and complete data associations within the system.
27+
28+
The Tools Manager is an integral part of the system, offering critical utilities to **keep data organized**, ensure smooth migrations, and fix orphaned data associations. These features enhance data integrity and improve the overall functionality of the system.
1429

15-
Welcome to the Comfort Accounting Tools Manager.
1630

1731

docs/comfortaccounting/user-guide/vc-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ card: "article"
1010

1111
---
1212

13-
# Comfort Accounting User Guide
13+
# Vendor Client Manager
1414

1515
The Vendor/Client (VC) Manager is designed to manage and organize vendors and clients within the system. This component provides an easy way to maintain crucial information related to each vendor or client, enhancing operational efficiency and data accuracy.
1616

0 commit comments

Comments
 (0)