Initial accounting reports documentation
This commit is contained in:
104
README.md
Normal file
104
README.md
Normal file
@@ -0,0 +1,104 @@
|
||||
# Open Squared Accounting Reports
|
||||
|
||||
Workspace de specification fonctionnelle des rapports comptables et financiers pour une plateforme CTRM / ERP open-source.
|
||||
|
||||
L'objectif du dossier est de maintenir un referentiel clair des rapports a produire, independamment du modele technique de donnees. Les mappings ERP / CTRM, vues SQL, jeux de donnees BI et controles de reconciliation pourront etre ajoutes ensuite.
|
||||
|
||||
## Structure
|
||||
|
||||
```text
|
||||
.
|
||||
|-- Docs/
|
||||
| |-- client_specific_excel_reports.md
|
||||
| |-- CTRM_ACCOUNTING_REPORTING_ARCHITECTURE.md
|
||||
| |-- reporting_catalog.md
|
||||
| |-- reporting_fields_catalog.md
|
||||
| |-- reporting_improvement_backlog.md
|
||||
| |-- reporting_parameters.md
|
||||
| |-- reporting_standards.md
|
||||
| |-- Trad On - Rapports Comptables et Financiers.xlsx
|
||||
| `-- DOCS_GUIDE.md
|
||||
|-- Reports/
|
||||
| |-- GL/
|
||||
| |-- STATUTORY/
|
||||
| |-- AR/
|
||||
| |-- AP/
|
||||
| |-- CASH/
|
||||
| |-- FX/
|
||||
| |-- TRADING/
|
||||
| |-- ANALYTICS/
|
||||
| `-- REPORTS_INDEX.md
|
||||
|-- security.toml
|
||||
`-- Open Squared Reporting.code-workspace
|
||||
```
|
||||
|
||||
## Documents de reference
|
||||
|
||||
- `Docs/client_specific_excel_reports.md` documente les rapports Excel specifiques client identifies pendant le cadrage.
|
||||
- `Docs/CTRM_ACCOUNTING_REPORTING_ARCHITECTURE.md` decrit l'architecture conceptuelle des couches de reporting.
|
||||
- `Docs/reporting_catalog.md` liste les domaines et les rapports cibles.
|
||||
- `Docs/reporting_fields_catalog.md` prepare le dictionnaire des champs a mapper avec le CTRM / ERP.
|
||||
- `Docs/reporting_improvement_backlog.md` suit les ameliorations fonctionnelles a appliquer aux specifications existantes.
|
||||
- `Docs/reporting_parameters.md` centralise les parametres communs.
|
||||
- `Docs/reporting_standards.md` fixe les conventions de champs, montants, signes et tris.
|
||||
- `Docs/Trad On - Rapports Comptables et Financiers.xlsx` est la source initiale de cadrage fonctionnel.
|
||||
|
||||
## Rapports specifies
|
||||
|
||||
| Domaine | Rapport | Fichier | Statut |
|
||||
| --- | --- | --- | --- |
|
||||
| General Ledger | GL-001 General Ledger | `Reports/GL/GL_001_general_ledger.md` | A revoir |
|
||||
| Statutory | FIN-001 Comparative Balance Sheet | `Reports/STATUTORY/FIN_001_comparative_balance_sheet.md` | Brouillon avance |
|
||||
| Statutory | FIN-002 Comparative Profit and Loss Statement | `Reports/STATUTORY/FIN_002_comparative_profit_and_loss_statement.md` | Brouillon avance |
|
||||
|
||||
## Rapports restant a specifier
|
||||
|
||||
Les rapports manquants sont suivis dans `Reports/REPORTS_INDEX.md`. La priorite naturelle est de completer les domaines deja identifies dans le catalogue:
|
||||
|
||||
1. General Ledger
|
||||
2. Statutory Financial Reporting
|
||||
3. Accounts Receivable
|
||||
4. Accounts Payable
|
||||
5. Banking and Cash Management
|
||||
6. Foreign Exchange
|
||||
7. Trading and Positions
|
||||
8. Analytical Accounting
|
||||
|
||||
## Convention de nommage
|
||||
|
||||
Chaque rapport doit etre documente dans le dossier de son domaine avec le format:
|
||||
|
||||
```text
|
||||
<CODE>_<numero>_<nom_en_snake_case>.md
|
||||
```
|
||||
|
||||
Exemples:
|
||||
|
||||
- `GL_002_accounting_journals.md`
|
||||
- `FIN_003_trial_balance.md`
|
||||
- `AR_002_customer_ageing_report.md`
|
||||
|
||||
## Structure minimale d'une specification de rapport
|
||||
|
||||
Chaque fiche de rapport devrait contenir:
|
||||
|
||||
1. Objective
|
||||
2. Users
|
||||
3. Frequency
|
||||
4. Parameters
|
||||
5. Filters
|
||||
6. Sorting
|
||||
7. Grouping
|
||||
8. Output Structure
|
||||
9. Estimated volume
|
||||
10. Export formats
|
||||
11. Controls / reconciliation rules
|
||||
12. Open questions
|
||||
|
||||
## Securite du workspace
|
||||
|
||||
Le fichier `security.toml` documente les regles locales de protection du repertoire: types de fichiers sensibles, operations a confirmer, conventions de conservation et limites de partage. Il ne remplace pas les droits SharePoint ou Windows, mais sert de politique lisible par l'equipe et par les assistants de travail.
|
||||
|
||||
## Assistant documentaire
|
||||
|
||||
Le fichier `AGENT.md` definit les regles de travail d'un assistant specialise dans la gestion documentaire de ce projet: mission, hierarchie des sources, checklist de specification, statuts, limites et workflow de creation des rapports manquants.
|
||||
Reference in New Issue
Block a user