Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates for grammar and Information presentation #46

Open
wants to merge 4 commits into
base: 3.0
Choose a base branch
from
Open

Documentation updates for grammar and Information presentation #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2f83f5d
Modifying documentation
Temidayo32 Jun 16, 2022
8dde1be
Converting lists into tables
Temidayo32 Jun 16, 2022
584193b
Updated Currrencies.md
Temidayo32 Jun 16, 2022
1083026
Merge pull request #1 from Knowledgeissweet/docs_experiment
Temidayo32 Jun 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions en/user-manual/apps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
App Store
=========

While we strongly believe that Akaunting is the best free accounting software out there, we're very well aware that it's not perfect, just like everything in the real world. Akaunting ships with core accounting tools needed to manage the money. For further features, instead of creating a bloated software by adding all of them to the core, we've created a modular structure so that it could get extended easily.
While we strongly believe that Akaunting is the best free accounting software, we're also aware it's not perfect. Akaunting ships with core accounting tools needed to manage money. For added features, we've created a modular structure so that it could be extended easily, instead of creating a bloated software by adding all of them to the core.

![apps home](_images/apps.gif)

For example, an app can connect your online store built with WooCommerce so that products, customers, and orders could get transferred to Akaunting automatically. Another one may connect with a CRM. And another one may be a payment gateway such as PayPal, Stripe etc to be used on the client side of Akaunting software to pay invoices online.

## API Key

In order to access the App Store from your Akaunting software installation, and install the apps you've purchased, you will need to get your [API Key](https://akaunting.com/dashboard) and enter it when you get asked for. That is the bridge between the software and site (akaunting.com).
In order to access the App Store from your Akaunting software installation, and install the apps you've purchased, you will need to get your [API Key](https://akaunting.com/dashboard) and enter it when you are prompted to provide it. It is the bridge between the software and site (akaunting.com).

![apps home](_images/apps-api-key.gif)

Expand Down
22 changes: 12 additions & 10 deletions en/user-manual/dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
Dashboard
=========

Dashboard is the first thing you will see when entering Akaunting. It is an adjustable view that may contain many types of information widgets, such as income/expense/profit totals, cash flow, incomes/expenses by category, latests incomes/expense, and more added by apps. You can have several dashboards that serve different purposes and switch between them.
Dashboard is the first thing you will see when entering Akaunting. It is an adjustable view that contains many types of information widgets, such as income/expense/profit totals, cash flow, incomes/expenses by category, latests incomes/expense, and more added by apps. You can have several dashboards that serve different purposes. You can also switch between them.

Widgets show the accrued incomes and expenses, except Cash Flow chart. [Here](https://akaunting.com/docs/faq/accrual-vs-cash) you can learn more about cash and accrual accounting.

![dashboard](_images/dashboard.png)

## Multiple Dashboards

You can have several dashboards that serve different purposes, switch between, and share them with your staff/accountant. To create a dashboard; click on the horizontal ellipsis (three dots) nearby the **Dashboard** word and select the **Create Dashboard** option.
You can have several dashboards that serve different purposes, switch between, and share them with your staff/accountant. To create a dashboard, click on the horizontal ellipsis (three dots) nearby the **Dashboard** word. Then, select the **Create Dashboard** option.

After adding new dashboards, the *Dashboard* menu will turn into a dropdown menu from where you can switch between dashboards.

Expand All @@ -19,18 +19,20 @@ After adding new dashboards, the *Dashboard* menu will turn into a dropdown menu

Akaunting ships with a number of widgets out-of-the-box that can simplify the day-to-day activities.

- **Totals:** Sum up the income, expense and profit state of your business. They also show the upcoming (not paid) invoices/bills.
- **Cash Flow:** Shows the income, expense and profit in cash per month/quarter.
- **Incomes By Category:** A pie chart to show the distribution of incomes.
- **Expenses By Category:** A pie chart to show the distribution of expenses.
- **Account Balance:** It shows the balance of each account you've added.
- **Latest Incomes:** A list that displays the last 5 incomes.
- **Latest Expenses:** A list that displays the last 5 expenses.
| Widget | Description |
| :------------------: | :------------------------------------------------------------------------------------------------------------------- |
| Totals | Sum up the income, expense and profit state of your business. They also show the upcoming (not paid) invoices/bills. |
| Cash Flow | Shows the income, expense and profit in cash per month/quarter. |
| Incomes By Category | A pie chart to show the distribution of incomes. |
| Expenses By Category | A pie chart to show the distribution of expenses. |
| Account Balance | It shows the balance of each account you've added. |
| Latest Incomes | A list that displays the last 5 incomes. |
| Latest Expenses | A list that displays the last 5 expenses. |

Total and chart widgets are displayed under the default currency. Invoices, revenues, bills, and payments created under a different currency will be converted based on the currency rate at the time they were created.

![add widget](_images/adding-new-widget.gif)

## Apps

Apps can also create a sparate dashboard with their specific widgets. For example, the [CRM](https://akaunting.com/apps/crm) app creates its own dashboard with widgets concentrated in customer relationship. The same process is available for [Payroll](https://akaunting.com/apps/payroll), [Double-Entry](https://akaunting.com/apps/double-entry), and lots of apps.
Apps can also create a seperate dashboard with their specific widgets. For example, the [CRM](https://akaunting.com/apps/crm) app creates its own dashboard with widgets concentrated in customer relationship. The same process is available for [Payroll](https://akaunting.com/apps/payroll), [Double-Entry](https://akaunting.com/apps/double-entry), and lots of apps.
34 changes: 19 additions & 15 deletions en/user-manual/items.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,31 @@ Check out the [Inventory](https://akaunting.com/apps/categories/inventory) app f

The following fields are displayed:

- **Picture**: Item's picture.
- **Name**: The name of product/service.
- **Category**: Category of item, if applicable.
- **Sale Price**: This price will be populated in invoices.
- **Purchase Price**: This price will be populated in bills.
- **Enabled**: Disabled items won't get populated when creating invoices/bills.
- **Actions**: You can use this button to edit, duplicate, and delete the item.
| Field | Description |
| :------------: | :--------------------------------------------------------------- |
| Picture | Item's picture. |
| Name | The name of product/service. |
| Category | Category of item, if applicable. |
| Sale Price | This price will be populated in invoices. |
| Purchase Price | This price will be populated in bills. |
| Enabled | Disabled items won't get populated when creating invoices/bills. |
| Actions | You can use this button to edit, duplicate, and delete the item. |

![items list](_images/items.gif)

## New Item

The following details are displayed as blank to be filled, some are required and some not. Those marked with red star are required.

- **Name**: The name of product/service.
- **Tax**: Any applicable tax. It will be populated when creating invoices/bills.
- **Description**: Item's description, if applicable.
- **Sale Price**: This price will be populated in invoices.
- **Purchase Price**: This price will be populated in bills.
- **Category**: Category of item, if applicable.
- **Picture**: Item's picture.
- **Enabled**: Disabled items won't get populated when creating invoices/bills.
| Field | Description |
| :------------: | :--------------------------------------------------------------------- |
| Name | The name of product/service. |
| Tax | Any applicable tax. It will be populated when creating invoices/bills. |
| Description | Item's description, if applicable. |
| Sale Price | This price will be populated in invoices. |
| Purchase Price | This price will be populated in bills. |
| Category | Category of item, if applicable. |
| Picture | Item's picture. |
| Enabled | Disabled items won't get populated when creating invoices/bills. |

![items form](_images/items-new-item.gif)
20 changes: 12 additions & 8 deletions en/user-manual/reports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Reports
=======

Reports allows you to get detailed financial data and help you better visualize all the information you need to improve your business. It gives you as a business owner a good idea of where your business income stands, month by month, and categorised.
Reports allows you to get detailed financial data. It helps you better visualize all the information you need to improve your business. It also gives you a good idea of where your business income stands, month by month, in a categorised manner.

All reports are displayed under the default currency. Income and expenses created under a different currency will be converted based on the currency rate at the time they were created.

Expand All @@ -19,15 +19,19 @@ If you click the report name/icon you'll be redirected to the report view page w

The following details are displayed as blank to be filled, some are required and some not. Those marked with red star are required.

- **Name**: The name of report.
- **Type**: There are 5 default types and it can be extended by apps.
- **Description**: Description to be used in report list.
| Field | Description |
| :---------: | :-------------------------------------------------------- |
| Name | The name of report. |
| Type | There are 5 default types and it can be extended by apps. |
| Description | Description to be used in report list. |

The following fields maybe available or not depending on the selected report type:

- **Group By**: You can group report by category, customer, etc. Each report type has its own groups.
- **Period**: You can set the report in monthly, quarterly, and yearly base.
- **Basis**: [Here](https://akaunting.com/docs/faq/accrual-vs-cash) you can learn more about cash and accrual accounting.
- **Chart**: Chart type to be used.
| Field | Description |
| :------: | :----------------------------------------------------------------------------------------------------------- |
| Group By | You can group report by category, customer, etc. Each report type has its own groups. |
| Period | You can set the report in monthly, quarterly, and yearly base. |
| Basis | [Here](https://akaunting.com/docs/faq/accrual-vs-cash) you can learn more about cash and accrual accounting. |
| Chart | Chart type to be used. |

![reports form](_images/reports-add-new.gif)
22 changes: 13 additions & 9 deletions en/user-manual/settings/categories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,26 @@ Categories page is located under **Settings > Categories** page. On this page yo

The following fields are displayed:

- **Name**: Category's name.
- **Type**: Categories are shown in items, incomes, and expenses page based on type.
- **Colour**: Category's colour, used in dashboard charts.
- **Status**: Status of the category.
- **Actions**: You can use this button to edit, and delete the category.
| Field | Description |
| :-----: | :----------------------------------------------------------------------- |
| Name | Category's name. |
| Type | Categories are shown in items, incomes, and expenses page based on type. |
| Colour | Category's colour, used in dashboard charts. |
| Status | Status of the category. |
| Actions | You can use this button to edit, and delete the category. |

![categories list](_images/categories.gif)

## New Category

The following fields are displayed as blank to be filled, some are required and some not. Those marked with red star are required.

- **Name**: Category's name.
- **Type**: Type of category. It will be shown in items, incomes, and expenses page based on type.
- **Colour**: This colour will be used in dashboard charts.
- **Enabled**: Status of the category.
| Field | Description |
| :-----: | :------------------------------------------------------------------------------------- |
| Name | Category's name. |
| Type | Type of category. It will be shown in items, incomes, and expenses page based on type. |
| Colour | This colour will be used in dashboard charts. |
| Enabled | Status of the category. |

![categories form](_images/categories-add-new.gif)

14 changes: 8 additions & 6 deletions en/user-manual/settings/company.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ Company Settings

Company settings page is located under **Settings** menu. On this page you can set up the settings for each company.

- **Name**: Company's name.
- **Email**: Company's email.
- **Tax Number**: The tax number to be used in invoices.
- **Phone**: Company's phone number.
- **Address**: The company address to be used in invoices.
- **Logo**: The company logo to be used in client portal, invoices etc.
| Setting | Description |
| :--------: | :---------------------------------------------------------- |
| Name | Company's name. |
| Email | Company's email. |
| Tax Number | The tax number to be used in invoices. |
| Phone | Company's phone number. |
| Address | The company address to be used in invoices. |
| Logo | The company logo to be used in client portal, invoices etc. |

![general company](_images/company.gif)
35 changes: 19 additions & 16 deletions en/user-manual/settings/currencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,31 @@ Currencies
Currencies page is located under **Settings > Currencies** page. On this page you can see all currencies, search for any, create a new one, edit the current ones and delete them.

The following fields are displayed:

- **Name**: Currency's name.
- **Code**: Unique ISO code of currency.
- **Rate**: The rate against the default currency. Default currency rate is always 1.
- **Status**: Status of the currency.
- **Actions**: You can use this button to edit, and delete the currency.
| Field | Description |
| :-----: | :------------------------------------------------------------------------ |
| Name | Currency's name. |
| Code | Unique ISO code of currency. |
| Rate | The rate against the default currency. Default currency rate is always 1. |
| Status | Status of the currency. |
| Actions | You can use this button to edit, and delete the currency. |

![currencies list](_images/currencies.gif)

## New Currency

The following fields are displayed as blank to be filled, some are required and some not. Those marked with red star are required.

- **Name**
- **Code:** The ISO code for the currency. Currency codes can be looked up at this [currency converter](http://www.oanda.com/currency/?srccont=rightnav).
- **Rate:** The rate against the default currency. Default currency rate is always 1.
- **Precision:** This defines number of fractions to be used.
- **Symbol:** The symbol of currency.
- **Symbol Position:** The position symbol.
- **Decimal Mark:** The mark to be used for decimal part.
- **Thousands Separator:** The mark to be used for thausands part.
- **Enabled:** Status of the currency.
- **Default Currency:** Set as the default currency of company. All reports are shown under the default currency.
| Field | Description |
| :-----------------: | :-------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Currency's name. |
| Code | The ISO code for the currency. Currency codes can be looked up at this [currency converter](http://www.oanda.com/currency/?srccont=rightnav). |
| Rate | The rate against the default currency. Default currency rate is always 1. |
| Precision | This defines number of fractions to be used. |
| Symbol | The symbol of currency. |
| Symbol Position | The position symbol. |
| Decimal Mark | The mark to be used for decimal part. |
| Thousands Separator | The mark to be used for thausands part. |
| Enabled | Status of the currency. |
| Default Currency | Set as the default currency of company. All reports are shown under the default currency. |

![currencies form](_images/currencies-add-new.gif)
Loading