← Quay lại blog

Ghi Chú Nhà Phát Triển: Lưu Nội Dung Kỹ Thuật Dưới Dạng Markdown Ưu Tiên Mã

· Save Team
developercodedocumentationapitemplates

Bạn đang debug lúc 2 giờ sáng. Bạn tìm thấy câu trả lời Stack Overflow. Bạn cần khối mã, giải thích và không gì khác. Không phải 47 bình luận ‘tôi cũng vậy’. Không phải quảng cáo thanh bên. Không phải carousel các câu hỏi liên quan.

Mẫu Developer của Save loại bỏ mọi thứ ngoại trừ những gì một nhà phát triển thực sự cần: mã, tham chiếu API và ngữ cảnh kỹ thuật.

Vấn Đề Đọc Của Nhà Phát Triển

Nội dung kỹ thuật trực tuyến bị chôn vùi dưới nhiễu:

  • Stack Overflow — câu trả lời được bao quanh bởi các phiếu, bình luận, quảng cáo
  • Tài liệu — mã quan trọng bị chôn vùi trong các đoạn giải thích
  • Blog hướng dẫn — ‘Đầu tiên, hãy để tôi nói với bạn tại sao tôi yêu JavaScript…’
  • README GitHub — một ví dụ mã bạn cần ở 400 dòng phía dưới
  • Tham chiếu API — bảng hữu ích bị ẩn giữa các bức tường văn xuôi

Mẫu Developer Hoạt Động Như Thế Nào

Mẫu Developer của Save xuất ra định dạng ưu tiên mã với năm phần:

  1. TL;DR — giải pháp trong một câu
  2. Tổng quan — ngữ cảnh kỹ thuật không có rườm rà
  3. Ví dụ Mã — mọi khối mã được bảo toàn chính xác
  4. Tham chiếu API — bảng với phương thức, tham số, kiểu trả về
  5. Ghi chú — các trường hợp biên, gotcha, hành vi đặc thù theo phiên bản

Tất cả các khối mã được bảo toàn với các điểm đánh dấu syntax highlighting. Biệt ngữ kỹ thuật giữ nguyên. Ngôn ngữ tiếp thị bị loại bỏ.

Ví Dụ Đầu Ra

Từ một trang tài liệu Next.js về Server Actions:

## TL;DR

Server Actions là các hàm async chạy trên máy chủ,
được định nghĩa với chỉ thị 'use server', có thể gọi trực tiếp từ
Client Components.

## Tổng Quan

Server Actions loại bỏ nhu cầu về API routes trong hầu hết các
kịch bản mutation. Chúng tích hợp với hệ thống caching và
revalidation của Next.js. Chỉ khả dụng trong App Router.

## Ví Dụ Mã

### Server Action Cơ Bản

\`\`\`typescript
'use server'

export async function createPost(formData: FormData) {
  const title = formData.get('title') as string
  await db.posts.create({ data: { title } })
  revalidatePath('/posts')
}
\`\`\`

### Sử Dụng Trong Client Component

\`\`\`typescript
'use client'

import { createPost } from './actions'

export function PostForm() {
  return (
    <form action={createPost}>
      <input name="title" />
      <button type="submit">Create</button>
    </form>
  )
}
\`\`\`

## Tham Chiếu API

| Function | Parameters | Returns |
|----------|-----------|---------|
| revalidatePath | path: string | void |
| revalidateTag | tag: string | void |
| redirect | url: string | never |
| cookies() | none | ReadonlyRequestCookies |

## Ghi Chú

- Server Actions phải là các hàm async
- Chỉ thị 'use server' có thể ở cấp độ hàm hoặc tệp
- Kích thước tối đa của body request: 1MB theo mặc định
- Hoạt động với progressive enhancement (không yêu cầu JS)
- Không thể được định nghĩa trong tệp Client Component

Các Trường Hợp Sử Dụng Hoàn Hảo

Lưu Các Câu Trả Lời Stack Overflow

Nhận câu trả lời được chấp nhận với các khối mã, trừ đi sự lộn xộn UI. Hoàn hảo để xây dựng thư viện tham khảo mã cá nhân.

Ảnh Chụp Tài Liệu

Lưu các trang tài liệu trước khi chúng thay đổi. API có phiên bản, tính năng không còn được hỗ trợ, hướng dẫn di chuyển — giữ một bản sao cục bộ.

Trích Xuất Hướng Dẫn

Lưu hướng dẫn lập trình được lột trần đến các bước và mã cần thiết. Không có tiểu sử tác giả, không có padding SEO.

Bộ Sưu Tập Tham Chiếu API

Xây dựng một cheat sheet API cá nhân bằng cách lưu các trang tham chiếu ở định dạng developer. Đầu ra bảng ngay lập tức hữu ích.

Ngữ Cảnh Code Review

Lưu tài liệu liên quan khi xem xét mã không quen thuộc. Chia sẻ các tham chiếu được định dạng developer trong bình luận PR.

Cách Thiết Lập

  1. Cài đặt Save từ Chrome Web Store (miễn phí)
  2. Mở Cài đặt và chọn “Developer 💻”
  3. Truy cập bất kỳ trang kỹ thuật nào — tài liệu, Stack Overflow, hướng dẫn
  4. Nhấp Save — Markdown ưu tiên mã ngay lập tức
  5. Lưu trữ trong vault của bạn — Obsidian, ghi chú VS Code, GitHub wiki

Được Xây Dựng Cho Nhà Phát Triển, Bởi Nhà Phát Triển

Ngừng sao chép khối mã thủ công. Ngừng định dạng lại tài liệu. Ngừng lội qua rườm rà hướng dẫn để tìm một lệnh bạn cần.

Mẫu Developer của Save cung cấp cho bạn Markdown ưu tiên mã từ bất kỳ trang kỹ thuật nào. Sạch, có cấu trúc, sẵn sàng để sử dụng.

Dùng thử Save miễn phí trên Chrome Web Store