CodeFlow-Inc / CodeFlow-Inc/ExpensesControl

Document the application design and create a diagram in draw.io.

オープン
#7 コメント 0 件 リアクション 0 件 担当者 1 名 @Rafael-Oliveira-Gomes が担当を希望しています GitHub で見る
documentation
主要言語
C#
スター
1
フォーク
0
PR マージ指標
30日以内にマージされた PR はありません

説明

**Product Backlog Item (PBI)**

Document the application design and create a diagram in draw.io.

---

### **English Version**

#### **Description**:
As a team, we need to document the application's design and create a structure to represent its structure in **draw.io**. The diagram should follow the existing design principles and include all relevant components and relationships, particularly the database table structure. The final document must be stored in the `/doc` folder of the project repository.

#### **Acceptance Criteria**:
1. Create a visual diagram in **draw.io** that accurately represents the application design.
- Include the provided database table `expenses` and its schema details.
- Show relationships, dependencies, and key components.
2. Save the diagram in a reusable and editable format (`.drawio` and `.png`).
3. Document the design process and decisions in a markdown (`.md`) file.
4. Store both the diagram and documentation in the `/doc` folder in the project repository.
5. Ensure the documentation includes the following:
- A brief overview of the application.
- Details about the `expenses` table schema.
- Future considerations or updates.

---

### **Versão em Português**

Documentar o design da aplicação e criar um diagrama no draw.io.

#### **Descrição**:
Como time, precisamos documentar a estrutura da aplicação e criar um diagrama para representar sua estrutura no **draw.io**. O diagrama deve seguir os princípios de design já existentes e incluir todos os componentes e relacionamentos relevantes, especialmente a estrutura da tabela de banco de dados. O documento final deve ser armazenado na pasta `/doc` do repositório do projeto.

#### **Critérios de Aceitação**:
1. Criar um diagrama visual no **draw.io** que represente com precisão o design da aplicação.
- Incluir a tabela de banco de dados `expenses` e os detalhes do seu esquema.
- Mostrar relacionamentos, dependências e componentes-chave.
2. Salvar o diagrama em um formato reutilizável e editável (`.drawio` e `.png`).
3. Documentar o processo e as decisões de design em um arquivo markdown (`.md`).
4. Armazenar tanto o diagrama quanto a documentação na pasta `/doc` do repositório do projeto.
5. Garantir que a documentação inclua:
- Um resumo do design da aplicação.
- Detalhes sobre o esquema da tabela `expenses`.
- Considerações futuras ou possíveis atualizações.

Design:
```sql
CREATE TABLE [dbo].[expenses] (
[Id] INT IDENTITY (1, 1) NOT NULL,
[user_code] INT NOT NULL,
[description] NVARCHAR (500) NULL,
[value] DECIMAL (18, 2) NOT NULL,
[start_date] DATE NOT NULL,
[end_date] DATE NULL,
[category] INT NOT NULL,
[is_recurring] BIT NOT NULL,
[recurrence_periodicity] INT NOT NULL,
[max_occurrences] INT NULL,
[payment_method_type] INT NOT NULL,
[is_installment] BIT NOT NULL,
[installment_count] INT NULL,
[installment_value] DECIMAL (18, 2) NULL,
[payment_notes] NVARCHAR (500) NULL,
[notes] NVARCHAR (1000) NULL,
[creation_date] DATETIME NOT NULL,
[created_by_user] NVARCHAR (100) NOT NULL,
[last_update_date] DATETIME NOT NULL,
[updated_by_user] NVARCHAR (100) NOT NULL,
CONSTRAINT [PK_expenses] PRIMARY KEY CLUSTERED ([Id] ASC)
);
```

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。