คุณเตรียมเอกสารทางเทคนิคอย่างไร?

2024 ผู้เขียน: Stanley Ellington | [email protected]. แก้ไขล่าสุด: 2023-12-16 00:24

การเขียนเพื่อผู้ชมของคุณ: 6 ขั้นตอนในการสร้างเอกสารทางเทคนิคที่ใช้งานได้

1. การวางแผน. ทราบวัตถุประสงค์และขอบเขตของโครงการก่อนเริ่มดำเนินการ
2. ร่าง. เริ่มต้นด้วยโครงร่างระดับสูงในทุกหัวข้อที่จะเปิดเผย
3. ทบทวน.
4. กำลังแก้ไข
5. กำลังแก้ไข
6. เผยแพร่/บำรุงรักษา.

พูดง่ายๆ ก็คือ เอกสารทางเทคนิคควรรวมอะไรบ้าง?

เทคนิค การเขียนรวมถึงเอกสารที่หลากหลาย ซึ่งรวมถึงคำแนะนำ บทวิจารณ์ รายงาน จดหมายข่าว การนำเสนอ หน้าเว็บ โบรชัวร์ ข้อเสนอ จดหมาย ใบปลิว กราฟิก บันทึกช่วยจำ ข่าวประชาสัมพันธ์ คู่มือ ข้อมูลจำเพาะ คู่มือรูปแบบ ระเบียบวาระการประชุม และอื่นๆ

นอกจากนี้ คุณจะเตรียมเอกสารสำหรับโครงการอย่างไร? แนวทางปฏิบัติที่ดีที่สุดสำหรับการจัดทำเอกสารโครงการของคุณ

1. รวมไฟล์ README ที่มี
2. อนุญาตให้ใช้ตัวติดตามปัญหาสำหรับผู้อื่น
3. เขียนเอกสาร API
4. เอกสารรหัสของคุณ
5. ใช้แบบแผนการเข้ารหัส เช่น การจัดระเบียบไฟล์ ความคิดเห็น หลักการตั้งชื่อ แนวทางปฏิบัติในการเขียนโปรแกรม ฯลฯ
6. รวมข้อมูลสำหรับผู้ร่วมให้ข้อมูล

ประการที่สอง การสร้างเอกสารทางเทคนิคคืออะไร?

เอกสารทางเทคนิค หมายถึงใดๆ เอกสาร ที่อธิบายการใช้งาน การทำงาน การสร้าง หรือสถาปัตยกรรมของผลิตภัณฑ์ คิดว่าเป็นคู่มือ "วิธีการ" แบบคร่าวๆ สำหรับผู้ใช้ พนักงานใหม่ ผู้ดูแลระบบ และใครก็ตามที่ต้องการทราบว่าผลิตภัณฑ์ของคุณทำงานอย่างไร

ฉันจะพัฒนาทักษะด้านเอกสารได้อย่างไร

ต่อไปนี้เป็นเคล็ดลับง่ายๆ และรวดเร็วบางประการที่จะช่วยคุณและทีมของคุณในการปรับปรุงเอกสารของคุณทันที

1. เคล็ดลับ 1) เลิกใช้ด้วย Passive Voice
2. เคล็ดลับ 2) ใช้ภาพธรรมดาเพื่อดึงดูดผู้อ่านของคุณ
3. เคล็ดลับ 3) ใช้ชื่อและสัญลักษณ์แสดงหัวข้อย่อยที่ยอดเยี่ยม
4. เคล็ดลับ 4) เชื่องคำย่อและคำที่ฉวัดเฉวียนของคุณ
5. เคล็ดลับ 5) ใช้มาตรฐานการทำซ้ำ