{"product_id":"claude-cho-engineering-viết-documentation-chuyen-nghiệp","title":"Claude cho Engineering: Viết documentation chuyên nghiệp","description":"\n\u003cp\u003eCode tốt không có documentation vẫn là code khó bảo trì. Một README rõ ràng, runbook đầy đủ, hay API docs chính xác có thể tiết kiệm hàng giờ onboarding và debug cho cả team. Claude có thể giúp bạn viết documentation chuyên nghiệp nhanh hơn, với cấu trúc rõ ràng và phù hợp với từng đối tượng đọc.\u003c\/p\u003e\n\n\u003ch2\u003eNăm loại documentation phổ biến\u003c\/h2\u003e\n\n\u003ch3\u003e1. README\u003c\/h3\u003e\n\u003cp\u003eCửa ngõ đầu tiên cho bất kỳ repository nào:\u003c\/p\u003e\n\u003cul\u003e\n  \u003cli\u003eDự án này là gì và tại sao tồn tại\u003c\/li\u003e\n  \u003cli\u003eQuick start (dưới 5 phút đến lần chạy đầu tiên)\u003c\/li\u003e\n  \u003cli\u003eConfiguration và usage\u003c\/li\u003e\n  \u003cli\u003eContributing guide\u003c\/li\u003e\n\u003c\/ul\u003e\n\n\u003ch3\u003e2. API Documentation\u003c\/h3\u003e\n\u003cul\u003e\n  \u003cli\u003eEndpoint reference với request\/response examples\u003c\/li\u003e\n  \u003cli\u003eAuthentication và error codes\u003c\/li\u003e\n  \u003cli\u003eRate limits và pagination\u003c\/li\u003e\n  \u003cli\u003eSDK examples\u003c\/li\u003e\n\u003c\/ul\u003e\n\n\u003ch3\u003e3. Runbook\u003c\/h3\u003e\n\u003cul\u003e\n  \u003cli\u003eKhi nào dùng runbook này\u003c\/li\u003e\n  \u003cli\u003ePrerequisites và quyền truy cập cần thiết\u003c\/li\u003e\n  \u003cli\u003eStep-by-step procedure\u003c\/li\u003e\n  \u003cli\u003eRollback steps\u003c\/li\u003e\n  \u003cli\u003eEscalation path\u003c\/li\u003e\n\u003c\/ul\u003e\n\n\u003ch3\u003e4. Architecture Document\u003c\/h3\u003e\n\u003cul\u003e\n  \u003cli\u003eContext và mục tiêu\u003c\/li\u003e\n  \u003cli\u003eHigh-level design với diagrams\u003c\/li\u003e\n  \u003cli\u003eKey decisions và trade-offs\u003c\/li\u003e\n  \u003cli\u003eData flow và integration points\u003c\/li\u003e\n\u003c\/ul\u003e\n\n\u003ch3\u003e5. Onboarding Guide\u003c\/h3\u003e\n\u003cul\u003e\n  \u003cli\u003eEnvironment setup\u003c\/li\u003e\n  \u003cli\u003eKey systems và cách chúng kết nối\u003c\/li\u003e\n  \u003cli\u003eCommon tasks với walkthroughs\u003c\/li\u003e\n  \u003cli\u003eHỏi ai về vấn đề gì\u003c\/li\u003e\n\u003c\/ul\u003e\n\n\u003ch2\u003eNguyên tắc viết documentation tốt\u003c\/h2\u003e\n\n\u003col\u003e\n  \u003cli\u003e\n\u003cstrong\u003eViết cho người đọc:\u003c\/strong\u003e Ai sẽ đọc tài liệu này và họ cần gì?\u003c\/li\u003e\n  \u003cli\u003e\n\u003cstrong\u003eThông tin quan trọng lên đầu:\u003c\/strong\u003e Đừng chôn thông tin thiết yếu ở cuối.\u003c\/li\u003e\n  \u003cli\u003e\n\u003cstrong\u003eShow, đừng chỉ tell:\u003c\/strong\u003e Code examples, commands, screenshots.\u003c\/li\u003e\n  \u003cli\u003e\n\u003cstrong\u003eGiữ up-to-date:\u003c\/strong\u003e Documentation cũ còn tệ hơn không có documentation.\u003c\/li\u003e\n  \u003cli\u003e\n\u003cstrong\u003eLink, không duplicate:\u003c\/strong\u003e Reference tài liệu khác thay vì copy.\u003c\/li\u003e\n\u003c\/ol\u003e\n\n\u003ch2\u003ePrompt mẫu: Tạo README\u003c\/h2\u003e\n\n\u003cpre\u003e\u003ccode\u003eViết README cho package npm của tôi:\n\nTên: @company\/vn-phone-validator\nMục đích: Validate số điện thoại Việt Nam (Viettel, Vinaphone, Mobifone)\nTech: TypeScript, không có dependencies\nFeatures:\n- Validate format (10 số, bắt đầu bằng 0)\n- Xác định nhà mạng từ prefix\n- Normalize format (0xxx -\u0026gt; +84xxx)\n- Hỗ trợ cả format cũ (11 số) để backward compat\n\nAudience: JavaScript\/TypeScript developers\nCần: Installation, quick example, full API reference, contributing guide\u003c\/code\u003e\u003c\/pre\u003e\n\n\u003ch2\u003ePrompt mẫu: Viết API Documentation\u003c\/h2\u003e\n\n\u003cpre\u003e\u003ccode\u003eViết API documentation cho các endpoints sau\ncủa hệ thống quản lý nhân sự:\n\nPOST \/api\/employees\n  Body: { name, email, department, startDate }\n  Returns: Employee object với id\n  Errors: 400 (validation), 409 (email duplicate), 500\n\nGET \/api\/employees\/:id\n  Returns: Full employee profile\n  Errors: 404 (not found), 403 (unauthorized)\n\nPUT \/api\/employees\/:id\n  Body: Partial employee object (patch)\n  Returns: Updated employee\n  Notes: Chỉ HR admin mới update department\n\nDELETE \/api\/employees\/:id\n  Soft delete, không xóa thật\n  Returns: 204 No Content\n\nAuth: Bearer JWT token\nRate limit: 100 req\/min per user\n\nFormat: OpenAPI 3.0 style, bao gồm curl examples\u003c\/code\u003e\u003c\/pre\u003e\n\n\u003ch2\u003eVí dụ kết quả: README từ Claude\u003c\/h2\u003e\n\n\u003cpre\u003e\u003ccode\u003e# @company\/vn-phone-validator\n\nValidate và normalize số điện thoại Việt Nam.\nHỗ trợ tất cả nhà mạng và tự động nhận diện carrier.\n\n## Cài đặt\n\nnpm install @company\/vn-phone-validator\n\n## Sử dụng nhanh\n\nconst { validate, getCarrier, normalize } = require('@company\/vn-phone-validator');\n\n\/\/ Validate\nvalidate('0912345678')   \/\/ true\nvalidate('0123456789')   \/\/ false (prefix không hợp lệ)\n\n\/\/ Nhận diện nhà mạng\ngetCarrier('0912345678')  \/\/ 'Mobifone'\ngetCarrier('0974123456')  \/\/ 'Viettel'\n\n\/\/ Normalize\nnormalize('0912345678')   \/\/ '+84912345678'\nnormalize('+84912345678') \/\/ '+84912345678' (idempotent)\n\n## API Reference\n...\n\n## Contributing\n...\u003c\/code\u003e\u003c\/pre\u003e\n\n\u003ch2\u003ePrompt mẫu: Viết Runbook\u003c\/h2\u003e\n\n\u003cpre\u003e\u003ccode\u003eViết runbook cho tình huống: Redis cache bị đầy\nvà service notification bắt đầu fail.\n\nService: notification-service (Node.js)\nInfrastructure: Redis 6.0 trên AWS ElastiCache\nMonitoring: CloudWatch alerts\n\nTình huống: CloudWatch alert \"Redis Memory \u0026gt; 90%\"\nẢnh hưởng: Push notifications chậm hoặc fail\n\nCần runbook với:\n1. Cách verify vấn đề\n2. Immediate mitigation (không cần restart)\n3. Permanent fix\n4. Rollback nếu action gây thêm vấn đề\n5. Escalation nếu không tự xử lý được\n\nNgười dùng runbook: On-call engineer,\ncó thể không quen sâu với Redis.\u003c\/code\u003e\u003c\/pre\u003e\n\n\u003ch2\u003ePrompt mẫu: Onboarding Guide\u003c\/h2\u003e\n\n\u003cpre\u003e\u003ccode\u003eViết onboarding guide cho backend developer mới\njoin team của chúng tôi.\n\nTech stack:\n- Node.js 20, TypeScript\n- PostgreSQL 15 + Redis\n- Docker + Docker Compose cho local dev\n- GitHub + GitHub Actions CI\/CD\n- AWS (ECS, RDS, ElastiCache)\n- Datadog cho monitoring\n\nCần cover:\n1. Setup môi trường local (từ zero đến chạy được)\n2. Cấu trúc codebase và conventions\n3. Workflow hàng ngày (branch, PR, review, merge)\n4. Cách chạy tests\n5. Cách debug và xem logs\n6. Ai hỏi về gì (Slack channels, team contacts)\n\nTarget: Developer mới, biết Node.js nhưng\nchưa biết gì về codebase chúng tôi.\u003c\/code\u003e\u003c\/pre\u003e\n\n\u003ch2\u003eBiến code thành documentation\u003c\/h2\u003e\n\n\u003cp\u003eClaude cũng có thể đọc code và tự động tạo documentation:\u003c\/p\u003e\n\n\u003cpre\u003e\u003ccode\u003eĐây là TypeScript function phức tạp.\nHãy viết JSDoc documentation cho nó,\nbao gồm description, @param, @returns,\n@throws, và @example:\n\nasync function processVietnamPayment(\n  amount: number,\n  method: 'momo' | 'vnpay' | 'banking',\n  customerId: string,\n  metadata?: Record\u0026lt;string, unknown\u0026gt;\n): Promise\u0026lt;PaymentResult\u0026gt; {\n  \/\/ [code implementation]\n}\u003c\/code\u003e\u003c\/pre\u003e\n\n\u003ch2\u003eDocumentation cho Vietnamese tech context\u003c\/h2\u003e\n\n\u003cp\u003eKhi viết documentation cho sản phẩm Việt Nam, có một số điểm cần lưu ý:\u003c\/p\u003e\n\n\u003cpre\u003e\u003ccode\u003eViết README cho SDK tích hợp thanh toán Việt Nam\n(MoMo, VNPay, ZaloPay).\n\nLưu ý đặc thù:\n- Môi trường sandbox và production có URL khác nhau\n- Cần giải thích về checksum\/signature verification\n  vì đây là yêu cầu bắt buộc của các cổng thanh toán VN\n- Các developers VN thường quen với PHP\/Java,\n  hãy include examples cho cả Node.js và Python\n- Documentation cần có cả tiếng Việt và tiếng Anh\u003c\/code\u003e\u003c\/pre\u003e\n\n\u003ch2\u003eMẹo viết documentation với Claude\u003c\/h2\u003e\n\n\u003cul\u003e\n  \u003cli\u003e\n\u003cstrong\u003eChỉ định audience rõ ràng:\u003c\/strong\u003e \"Viết cho developer mới, chưa biết AWS\" khác với \"Viết cho senior DevOps engineer\".\u003c\/li\u003e\n  \u003cli\u003e\n\u003cstrong\u003eCung cấp context về codebase:\u003c\/strong\u003e Càng nhiều context về tech stack và conventions, documentation càng chính xác.\u003c\/li\u003e\n  \u003cli\u003e\n\u003cstrong\u003eYêu cầu format cụ thể:\u003c\/strong\u003e \"Markdown\", \"OpenAPI 3.0\", hoặc \"Confluence wiki format\".\u003c\/li\u003e\n  \u003cli\u003e\n\u003cstrong\u003eReview và bổ sung:\u003c\/strong\u003e Claude tạo khung tốt nhưng bạn cần thêm context nội bộ như tên system, URL thực, credentials placeholder.\u003c\/li\u003e\n\u003c\/ul\u003e\n\n\u003ch2\u003eBước tiếp theo\u003c\/h2\u003e\n\u003cp\u003eDocumentation tốt là nền tảng của engineering team hiệu quả:\u003c\/p\u003e\n\u003cul\u003e\n  \u003cli\u003e\u003ca href=\"\/collections\/ung-dung\"\u003eThư viện ứng dụng Claude cho Engineering\u003c\/a\u003e\u003c\/li\u003e\n  \u003cli\u003eKết hợp với Architecture workflow để document các quyết định thiết kế quan trọng\u003c\/li\u003e\n  \u003cli\u003eDùng Runbook workflow trong Incident Response khi có sự cố production\u003c\/li\u003e\n\u003c\/ul\u003e\n\n\n\u003chr\u003e\n\u003ch3\u003eBài viết liên quan\u003c\/h3\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href=\"\/products\/claude-cho-engineering-chi%E1%BA%BFn-l%C6%B0%E1%BB%A3c-testing-toan-di%E1%BB%87n\"\u003eClaude cho Engineering: Chiến lược testing toàn diện\u003c\/a\u003e\u003c\/li\u003e\n\u003cli\u003e\u003ca href=\"\/products\/claude-cho-engineering-debug-va-x%E1%BB%AD-ly-l%E1%BB%97i\"\u003eClaude cho Engineering: Debug và xử lý lỗi\u003c\/a\u003e\u003c\/li\u003e\n\u003cli\u003e\u003ca href=\"\/products\/claude-cho-engineering-deploy-checklist-t%E1%BB%B1-d%E1%BB%99ng\"\u003eClaude cho Engineering: Deploy checklist tự động\u003c\/a\u003e\u003c\/li\u003e\n\u003cli\u003e\u003ca href=\"\/products\/best-practices-cho-vision-t%E1%BB%91i-%C6%B0u-hinh-%E1%BA%A3nh-g%E1%BB%ADi-claude\"\u003eBest Practices cho Vision — Tối ưu hình ảnh gửi Claude\u003c\/a\u003e\u003c\/li\u003e\n\u003cli\u003e\u003ca href=\"\/products\/claude-cho-data-validation-va-data-quality\"\u003eClaude cho Data: Validation và data quality\u003c\/a\u003e\u003c\/li\u003e\n\u003c\/ul\u003e","brand":"Minh Tuấn","offers":[{"title":"Default Title","offer_id":47722092363988,"sku":null,"price":0.0,"currency_code":"VND","in_stock":true}],"thumbnail_url":"\/\/cdn.shopify.com\/s\/files\/1\/0821\/0264\/9044\/files\/claude-cho-engineering-vi_t-documentation-chuyen-nghi_p_9448b97c-c71c-4e49-aade-26d9041dabfa.jpg?v=1774522001","url":"https:\/\/claude.vn\/products\/claude-cho-engineering-vi%e1%ba%bft-documentation-chuyen-nghi%e1%bb%87p","provider":"CLAUDE.VN","version":"1.0","type":"link"}