Passive Voice Trong Technical Writing — Hướng Dẫn Cho Developer

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

❌ Active (quá personal):
"We send a JSON response with status code 200."

✅ Passive (chuẩn doc):
"A JSON response is sent with status code 200."

❌ Active:
"The system validates the API key in every request."

✅ Passive:
"The API key is validated in every request."

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

## v2.5.0 — March 2026

### Added
- Dark mode **has been implemented** for all UI components.
- Webhook support **has been added** for real-time notifications.

### Fixed
- Memory leak in connection pooling **has been resolved**.
- Race condition in payment processing **was fixed**.

### Changed
- Default timeout **has been increased** from 30s to 60s.
- Legacy API endpoints **have been deprecated**.

### Security
- All passwords **are now hashed** using bcrypt.
- SQL injection vulnerability **was patched**.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

Title: Data is not saved when form is submitted

**Description:**
When the submit button is clicked, the data is not persisted
to the database. The request is sent but a 500 error
is returned by the server.

**Steps to Reproduce:**
1. The form is filled with valid data.
2. The "Save" button is clicked.
3. An error message is displayed.

**Expected:** Data should be saved successfully.
**Actual:** A 500 Internal Server Error is returned.

1
2
3
4
5
6
7

Data Flow:
1. User input is received by the API Gateway.
2. The request is validated and authenticated.
3. Data is transformed and sent to the message queue.
4. The message is consumed by the worker service.
5. Results are stored in the database.
6. A notification is sent to the client via WebSocket.

1
2
3
4
5
6
7

❌ "Our team fixed the production issue at 3 PM."
✅ "The production issue was resolved at 3 PM."
   (Chuyên nghiệp hơn — client không cần biết ai fix)

❌ "We have completed the migration."
✅ "The migration has been completed successfully."
   (Tập trung vào kết quả)

1
2
3
4
5

❌ "The PR should be reviewed by you."
✅ "Hey, can you review my PR?"

❌ "It has been decided that we use PostgreSQL."
✅ "We decided to go with PostgreSQL."

1
2
3
4
5
6
7
8
9

## Installation (Active — vì đây là instruction)
1. Clone the repository.
2. Run `npm install`.
3. Configure the `.env` file.

## Architecture (Passive — vì đây là description)
- Requests are routed through the API Gateway.
- Data is stored in PostgreSQL.
- Background jobs are processed by Redis workers.

1
2

❌ "The file saved to disk."
✅ "The file was saved to disk."

1
2
3
4
5

❌ "The data is store in the database."
✅ "The data is stored in the database."

❌ "The function was ran by the scheduler."
✅ "The function was run by the scheduler."

1
2
3
4
5
6

❌ "The request is received, then it is validated, then it is
   processed, then a response is generated, and it is sent."

✅ "The system receives the request, validates it, processes the
   data, and returns a response."
   (Mix Active + Passive cho dễ đọc)

1
2

❌ "The 'Submit' button should be clicked by the user."
✅ "Click the 'Submit' button."