Documentación de código con Notion AI

5. Documentación de código con Notion AI

Herramientas funcionales para documentar

• Notion AI
• ChatGPT
• Bard
• Bing

Herramientas totalmente funcionales para realizar las tareas que a veces pueden ser tediosas de documentación que es una buena práctica para la manutención y actualización de código.

• Documentar tus procesos ayuda a entender los procesos de otros colaboradores.
• Funcionan con la mayoría de lenguajes.
• También sirve para entender código de alguien mas.

Una duda que me surge, esto no es peligroso? Digo es una forma de darle a una pagina todo el codigo de una empresa sin saber realmente como funciona por detras

Prompt to ask the Notion AI to create documentation from a block SQL code

Crea una documentación técnica como diccionario de datos y agrega descripciones de las columnas y las tablas en el modelo DDL de bases de datos

Prompt to create documentation from a Python script

Eres un experto en Python y en buenas prácticas de documentación de código, te daré un script en Python y tienes que comentarlo y hacer una descripción de la función del script, utiliza documentación técnica de alto nivel:

Script:

create table categories(    category\_id   smallint    not null        constraint pk\_categories            primary key,    category\_name varchar(15) not null,    description   text,    picture       bytea); create table customer\_customer\_demo(    customer\_id      varchar(5) not null        constraint fk\_customer\_customer\_demo\_customers            references customers,    customer\_type\_id varchar(5) not null        constraint fk\_customer\_customer\_demo\_customer\_demographics            references customer\_demographics,    constraint pk\_customer\_customer\_demo        primary key (customer\_id, customer\_type\_id)); create table customer\_demographics(    customer\_type\_id varchar(5) not null        constraint pk\_customer\_demographics            primary key,    customer\_desc    text); create table customers(    customer\_id   varchar(5)  not null        constraint pk\_customers            primary key,    company\_name  varchar(40) not null,    contact\_name  varchar(30),    contact\_title varchar(30),    address       varchar(60),    city          varchar(15),    region        varchar(15),    postal\_code   varchar(10),    country       varchar(15),    phone         varchar(24),    fax           varchar(24)); create table employee\_territories(    employee\_id  smallint    not null        constraint fk\_employee\_territories\_employees            references employees,    territory\_id varchar(20) not null        constraint fk\_employee\_territories\_territories            references territories,    constraint pk\_employee\_territories        primary key (employee\_id, territory\_id)); create table employees(    employee\_id       smallint    not null        constraint pk\_employees            primary key,    last\_name         varchar(20) not null,    first\_name        varchar(10) not null,    title             varchar(30),    title\_of\_courtesy varchar(25),    birth\_date        date,    hire\_date         date,    address           varchar(60),    city              varchar(15),    region            varchar(15),    postal\_code       varchar(10),    country           varchar(15),    home\_phone        varchar(24),    extension         varchar(4),    photo             bytea,    notes             text,    reports\_to        smallint        constraint fk\_employees\_employees            references employees,    photo\_path        varchar(255)); create table order\_details(    order\_id   smallint not null        constraint fk\_order\_details\_orders            references orders,    product\_id smallint not null        constraint fk\_order\_details\_products            references products,    unit\_price real     not null,    quantity   smallint not null,    discount   real     not null,    constraint pk\_order\_details        primary key (order\_id, product\_id)); create table orders(    order\_id         smallint not null        constraint pk\_orders            primary key,    customer\_id      varchar(5)        constraint fk\_orders\_customers            references customers,    employee\_id      smallint        constraint fk\_orders\_employees            references employees,    order\_date       date,    required\_date    date,    shipped\_date     date,    ship\_via         smallint        constraint fk\_orders\_shippers            references shippers,    freight          real,    ship\_name        varchar(40),    ship\_address     varchar(60),    ship\_city        varchar(15),    ship\_region      varchar(15),    ship\_postal\_code varchar(10),    ship\_country     varchar(15)); create table product\_details(    product\_id  smallint                            not null        constraint pk\_product\_details            primary key        constraint fk\_product\_details\_products            references products,    description text,    picture     text,    status      integer,    last\_update timestamp default CURRENT\_TIMESTAMP not null); create table products(    product\_id        smallint    not null        constraint pk\_products            primary key,    product\_name      varchar(40) not null,    supplier\_id       smallint        constraint fk\_products\_suppliers            references suppliers,    category\_id       smallint        constraint fk\_products\_categories            references categories,    quantity\_per\_unit varchar(20),    unit\_price        real,    units\_in\_stock    smallint,    units\_on\_order    smallint,    reorder\_level     smallint,    discontinued      integer     not null); create table region(    region\_id          smallint    not null        constraint pk\_region            primary key,    region\_description varchar(60) not null); create table shippers(    shipper\_id   smallint    not null        constraint pk\_shippers            primary key,    company\_name varchar(40) not null,    phone        varchar(24)); create table suppliers(    supplier\_id   smallint    not null        constraint pk\_suppliers            primary key,    company\_name  varchar(40) not null,    contact\_name  varchar(30),    contact\_title varchar(30),    address       varchar(60),    city          varchar(15),    region        varchar(15),    postal\_code   varchar(10),    country       varchar(15),    phone         varchar(24),    fax           varchar(24),    homepage      text); create table territories(    territory\_id          varchar(20) not null        constraint pk\_territories            primary key,    territory\_description varchar(60) not null,    region\_id             smallint    not null        constraint fk\_territories\_region            references region); create table us\_states(    state\_id     smallint not null        constraint pk\_usstates            primary key,    state\_name   varchar(100),    state\_abbr   varchar(2),    state\_region varchar(50));

### Tables #### 1. USERS Description: Stores information about system users. **Column** **Data Type** **Description** user\_id INT Unique identifier for the user (Primary Key) first\_name VARCHAR(50) User's first name last\_name VARCHAR(50) User's last name email VARCHAR(100) User's email address registration\_date DATE Date when the user registered in the system #### 2. PRODUCTS Description: Contains information about available products. **Column** **Data Type** **Description** product\_id INT Unique identifier for the product (Primary Key) name VARCHAR(100) Product name description TEXT Detailed description of the product price DECIMAL(10,2) Product price stock INT Available quantity in inventory #### 3. ORDERS Description: Records orders placed by users. **Column** **Data Type** **Description** order\_id INT Unique identifier for the order (Primary Key) user\_id INT ID of the user who placed the order (Foreign Key to USERS) order\_date DATETIME Date and time when the order was placed status VARCHAR(20) Current status of the order (e.g., 'Pending', 'Shipped', 'Delivered') total DECIMAL(10,2) Total amount of the order #### 4. ORDER\_DETAILS Description: Stores the details of each order, including specific products. **Column** **Data Type** **Description** detail\_id INT Unique identifier for the order detail (Primary Key) order\_id INT ID of the order this detail belongs to (Foreign Key to ORDERS) product\_id INT ID of the product included in this detail (Foreign Key to PRODUCTS) quantity INT Quantity of the product in this order detail unit\_price DECIMAL(10,2) Unit price of the product at the time of purchase ### Table Relationships ORDERS.user\_id relates to USERS.user\_id ORDER\_DETAILS.order\_id relates to ORDERS.order\_id ORDER\_DETAILS.product\_id relates to PRODUCTS.product\_id ### Recommended Indexes USERS: Index on email for quick searches PRODUCTS: Index on name for product name searches ORDERS: Index on user\_id and order\_date for frequent queries ORDER\_DETAILS: Indexes on order\_id and product\_id to improve performance of detail queries

Deberías subir el script se ve interesante, me refiero al de twitter de acuerdo a un #