AI Prompt Engineering · บทเรียน

พรอมป์ตสำหรับเอกสารทางเทคนิค

ไฟล์ README เอกสาร API และคู่มือวิธีใช้ด้วยภาษาทางเทคนิคที่ถูกต้อง

พรอมป์ตสำหรับเอกสารทางเทคนิค เป็นบทเรียน AI Prompt Engineering ฟรีบน CoddyKit นี่คือบทเรียนที่ 3 จากทั้งหมด 4 บทเรียน คุณสามารถอ่านบทเรียนทั้งหมดด้านล่างฟรี — จากนั้นลองปฏิบัติด้วยตัวคุณเองในเบราว์เซอร์พร้อมตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7 บทเรียนนี้เป็นส่วนหนึ่งของเส้นทางการเรียน AI Prompt Engineering และความก้าวหน้าของคุณจะซิงค์ข้ามเว็บและแอป CoddyKit คอร์ส AI Prompt Engineering มีบทเรียนทั้งหมด 4 บทเรียน

เอกสารทางเทคนิคเป็นประเภทงานเขียน

เอกสารทางเทคนิคเป็นประเภทงานเขียนที่มีลักษณะเฉพาะและแบบแผนชัดเจน: เน้นความแม่นยำมากกว่าสำนวน เน้นโครงสร้างมากกว่าเรื่องเล่า และเน้นความครบถ้วนมากกว่าความกระชับ พรอมต์ที่ใช้ได้กับบทความบล็อกหรืออีเมลจะให้ระดับภาษาไม่ถูกต้องสำหรับเอกสารทางเทคนิค

พรอมต์เอกสารทางเทคนิคที่มีประสิทธิภาพจะระบุประเภทงานเขียนอย่างชัดเจน ซึ่งรวมถึงประเภทเอกสาร ระดับความรู้ที่ถือว่าผู้อ่านมีอยู่แล้ว โครงสร้างมาตรฐานสำหรับเอกสารประเภทนั้น และแบบแผนด้านน้ำเสียง (โดยทั่วไปใช้บุรุษที่สองสำหรับคู่มือวิธีทำ และบุรุษที่สามสำหรับเอกสารอ้างอิง)

พรอมต์สำหรับไฟล์ README

README เป็นจุดเริ่มต้นสำหรับทำความรู้จักโครงการ โครงสร้างมาตรฐานของ README เป็นที่ยอมรับอย่างชัดเจน พรอมต์ README ที่มีประสิทธิภาพจะระบุแต่ละส่วนดังนี้:

ชื่อโครงการและคำอธิบายหนึ่งบรรทัด
ทำอะไร: วัตถุประสงค์ 2–3 ประโยค
สิ่งที่ต้องมี: สิ่งที่ต้องติดตั้ง
การติดตั้ง: ขั้นตอนลำดับเลขพร้อมคำสั่ง
เริ่มต้นใช้งานอย่างรวดเร็ว: ตัวอย่างการทำงานขั้นต่ำ
การกำหนดค่า: ตัวแปรสภาพแวดล้อมและตัวเลือก
การมีส่วนร่วม: วิธีส่งคำขอเปลี่ยนแปลงโค้ด
สิทธิ์การใช้งาน

การระบุชื่อทุกส่วนในพรอมต์จะทำให้ได้ README ที่ครบถ้วน หากไม่สั่งอย่างชัดเจน ส่วนที่ขาดหายไปจะถูกละเว้น

พรอมต์ README ในโค้ด

ตัวสร้าง README แบบมีโครงสร้างที่รับข้อมูลเมตาของโครงการ:

import openai

client = openai.OpenAI(api_key='sk-...')

def generate_readme(project_name, description, language, dependencies,
                    install_steps, quick_start_example, config_vars, license_type):

    prompt = f'''Write a README.md for the following project.

Project name: {project_name}
Description: {description}
Language/stack: {language}
Dependencies: {dependencies}
Installation steps: {install_steps}
Quick start example: {quick_start_example}
Key configuration variables: {config_vars}
License: {license_type}

Structure the README with these sections in order:
1. Project title and badge line (GitHub stars, license)
2. One-sentence description
3. Features (3-5 bullet points)
4. Prerequisites
5. Installation (numbered steps with code blocks)
6. Quick Start (minimal working example in a code block)
7. Configuration (table: Variable | Description | Default)
8. Contributing (2-3 sentences)
9. License

Voice: second person imperative for steps ("Run...", "Install...").
Code blocks: use correct language identifiers.
Do not add placeholder content — only include sections where I provided information.'''

    response = client.chat.completions.create(
        model='gpt-4o-mini',
        messages=[{'role': 'user', 'content': prompt}]
    )
    return response.choices[0].message.content

พรอมต์เอกสาร API

เอกสาร API มีโครงสร้างตายตัว รายการจุดปลายทางแต่ละรายการต้องมีวิธี HTTP เส้นทาง คำอธิบาย พารามิเตอร์ เนื้อหาคำขอ รูปแบบการตอบกลับ รหัสข้อผิดพลาด และตัวอย่าง พรอมต์ต้องระบุองค์ประกอบทั้งหมดดังนี้:

"เขียนเอกสาร API สำหรับจุดปลายทาง REST โปรดใส่: วิธี (POST) เส้นทาง (/api/v1/users) คำอธิบาย ตารางพารามิเตอร์ (ชื่อ ชนิด จำเป็น คำอธิบาย) ตัวอย่าง JSON ของเนื้อหาคำขอ ตัวอย่าง JSON ของการตอบกลับสำเร็จ (200) การตอบกลับข้อผิดพลาด (400, 401, 422) พร้อมตัวอย่าง JSON น้ำเสียง: บุรุษที่สาม กาลปัจจุบัน ใช้ตารางมาร์กดาวน์สำหรับพารามิเตอร์"

ต้องระบุองค์ประกอบด้านโครงสร้างแต่ละรายการอย่างชัดเจน โมเดลจะไม่คาดเดามาตรฐานเอกสารของคุณ

พรอมต์สำหรับคู่มือวิธีการ

คู่มือวิธีการเป็นเนื้อหาเชิงขั้นตอน โดยนำผู้อ่านจากสถานะ A (ปัญหา) ไปสู่สถานะ B (วิธีแก้ไข) ผ่านขั้นตอนที่มีหมายเลขกำกับ องค์ประกอบของพรอมต์สำหรับคู่มือวิธีการมีดังนี้:

ข้อกำหนดเบื้องต้น: สิ่งที่ต้องเป็นจริงก่อนเริ่มต้น
ผลลัพธ์: สิ่งที่ผู้อ่านจะทำสำเร็จ
ขั้นตอน: มีหมายเลขกำกับ และแต่ละขั้นทำเพียงหนึ่งอย่าง ไม่ใช่รวมหลายการกระทำไว้ในขั้นตอนเดียว
ตัวอย่างโค้ด: หนึ่งตัวอย่างต่อหนึ่งขั้นเมื่อเกี่ยวข้อง พร้อมระบุภาษา
การตรวจสอบ: วิธีที่ผู้อ่านใช้ยืนยันว่าแต่ละขั้นตอนสำเร็จ
การแก้ไขปัญหา: รูปแบบความล้มเหลวที่พบบ่อยสำหรับสองหรือสามขั้นตอนที่ซับซ้อนที่สุด

ความถูกต้องทางเทคนิคในพรอมต์สำหรับเอกสารประกอบ

เอกสารประกอบทางเทคนิคมีข้อกำหนดด้านความถูกต้องสูงกว่าเนื้อหาส่วนใหญ่ เทคนิคสองประการสำหรับปรับปรุงความถูกต้องในพรอมต์สำหรับเอกสารประกอบมีดังนี้:

จัดเตรียมโค้ดจริง: วางลายเซ็นฟังก์ชัน ตัวเลือกการกำหนดค่า หรือข้อกำหนดเอพีไอจริงลงไป โมเดลจะจัดทำเอกสารจากสิ่งที่มีอยู่จริง แทนการแต่งรายละเอียดขึ้นมา

ขอขั้นตอนการตรวจสอบ: "หลังจากเขียนแต่ละขั้นตอน ให้ระบุสมมติฐานที่คุณตั้งขึ้นเกี่ยวกับสภาพแวดล้อมของผู้ใช้หรือพฤติกรรมของระบบ และแจ้งสิ่งที่ฉันควรตรวจสอบก่อนเผยแพร่"

อย่าใช้เอกสารประกอบที่สร้างโดยปัญญาประดิษฐ์โดยไม่มีการตรวจทานทางเทคนิค โมเดลอาจจัดทำเอกสารเกี่ยวกับสิ่งที่ไม่มีอยู่จริงหรือไม่ถูกต้องได้อย่างมั่นใจ

คุณภาพของตัวอย่างโค้ดในเอกสารประกอบ

ตัวอย่างโค้ดเป็นองค์ประกอบที่สำคัญที่สุดของเอกสารประกอบทางเทคนิค ควรระบุข้อกำหนดสำหรับตัวอย่างเหล่านี้อย่างชัดเจน:

"ใส่ตัวอย่างโค้ดที่ใช้งานได้หนึ่งตัวอย่างต่อแนวคิดสำคัญหนึ่งแนวคิด ตัวอย่างควรทำงานได้ในตัวเอง เพื่อให้ผู้อ่านคัดลอก วาง และเรียกใช้ได้"
"แสดงทั้งการใช้งานที่ถูกต้องและข้อผิดพลาดที่พบบ่อย พร้อมความเห็นอธิบายว่าเหตุใดข้อผิดพลาดนั้นจึงทำงานไม่สำเร็จ"
"ตัวอย่างโค้ดควรใช้ชื่อและข้อมูลตัวแปรที่สมจริง ไม่ใช่ 'ฟู' 'บาร์' หรือ 'ทดสอบ'"
"ภาษา: ไพธอน 3.11 ใช้คำใบ้ชนิดข้อมูล และจัดการข้อผิดพลาดสำหรับการเรียกเครือข่าย"

หากไม่ระบุข้อกำหนดสำหรับตัวอย่างโค้ดอย่างชัดเจน โมเดลอาจสร้างส่วนย่อยของรหัสเทียมที่ไม่ครบถ้วนและไม่สามารถเรียกใช้ได้จริง

น้ำเสียงและรูปแบบของเอกสารประกอบ

เอกสารประกอบทางเทคนิคมีน้ำเสียงเฉพาะ ซึ่งแตกต่างจากงานเขียนประเภทอื่น:

ใช้บุรุษที่สองในรูปคำสั่งสำหรับขั้นตอน: "คลิกการตั้งค่า เลือกแท็บเอพีไอ ป้อนคีย์ของคุณ"
ใช้บุรุษที่สามสำหรับเอกสารอ้างอิง: "เมธอด authenticate() ส่งคืนโทเค็นแบบผู้ถือสิทธิ์ที่ใช้งานได้ 24 ชั่วโมง"
ใช้กาลปัจจุบัน: "ฟังก์ชันส่งคืน..." ไม่ใช่ "ฟังก์ชันจะส่งคืน..."
ไม่ใช้ถ้อยคำลังเล: "เรียกใช้คำสั่งนี้" ไม่ใช่ "คุณอาจพิจารณาเรียกใช้คำสั่งนี้"
ใช้คำศัพท์อย่างสม่ำเสมอ: ใช้คำเดียวกันสำหรับแนวคิดเดียวกันตลอดทั้งเอกสาร ไม่ใช้คำพ้องความหมายสลับกัน

พรอมต์สำหรับบันทึกการเปลี่ยนแปลงและบันทึกประจำรุ่น

บันทึกการเปลี่ยนแปลงและบันทึกประจำรุ่นมีรูปแบบมาตรฐานที่ควรระบุไว้ในพรอมต์:

"เขียนบันทึกประจำรุ่นสำหรับรุ่น 2.3.0 รูปแบบ: ส่วนหัวรุ่น วันที่เผยแพร่ แล้วตามด้วยสามส่วน ได้แก่ 'เพิ่ม' (คุณลักษณะใหม่) 'เปลี่ยนแปลง' (การปรับแก้คุณลักษณะที่มีอยู่) และ 'แก้ไขแล้ว' (การแก้ไขข้อบกพร่อง) แต่ละรายการมีหนึ่งบรรทัด ใช้รูปประโยคที่ประธานเป็นผู้กระทำ และขึ้นต้นด้วยคำกริยา กลุ่มผู้อ่าน: นักพัฒนาที่ผสานรวมไลบรารีนี้ น้ำเสียง: แม่นยำและเป็นกลาง ไม่ใช้ภาษาการตลาด ต่อไปนี้คือการเปลี่ยนแปลง: [รายการการเปลี่ยนแปลงจริง]"

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

การตรวจสอบความครบถ้วนของเอกสารประกอบ

หลังจากสร้างเอกสารประกอบทางเทคนิคแล้ว ให้เรียกใช้พรอมต์ตรวจสอบความครบถ้วน:

import openai

client = openai.OpenAI(api_key='sk-...')

def check_documentation_completeness(doc_text, doc_type='how-to guide'):
    checklist = {
        'how-to guide': [
            'Prerequisites stated?',
            'Expected outcome stated?',
            'Each step is a single action?',
            'Code examples included where relevant?',
            'Validation step for each major action?',
            'Common errors addressed?'
        ],
        'readme': [
            'One-line description present?',
            'Installation steps numbered with commands?',
            'Quick start example included?',
            'Configuration variables documented?',
            'License specified?'
        ]
    }

    items = checklist.get(doc_type, [])
    check_prompt = f'Review this {doc_type} and answer each question (Yes/No + brief note):\n'
    for item in items:
        check_prompt += f'- {item}\n'
    check_prompt += f'\nDocument:\n{doc_text[:2000]}'

    response = client.chat.completions.create(
        model='gpt-4o-mini',
        messages=[{'role': 'user', 'content': check_prompt}]
    )
    return response.choices[0].message.content

การแปลศัพท์เฉพาะสำหรับกลุ่มผู้อ่านที่หลากหลาย

เอกสารประกอบทางเทคนิคมักต้องรองรับทั้งผู้อ่านที่มีพื้นฐานทางเทคนิคและผู้ที่ไม่มีพื้นฐานทางเทคนิค รูปแบบพรอมต์ที่ใช้ได้จริงมีดังนี้:

"เขียนเอกสารประกอบนี้เป็นสองระดับ ระดับแรก: สรุปสำหรับผู้ที่ไม่มีพื้นฐานทางเทคนิคจำนวน 3 ประโยค (สิ่งนี้ทำอะไร เหตุใดจึงสำคัญ และควรใช้เมื่อใด) ระดับที่สอง: ข้อกำหนดทางเทคนิคฉบับเต็ม ใช้ตัวคั่นที่เห็นได้ชัดระหว่างสองระดับ วิธีนี้ช่วยให้ผู้จัดการที่ไม่มีพื้นฐานทางเทคนิคอ่านเฉพาะสรุปแล้วหยุดได้ ส่วนผู้อ่านที่มีพื้นฐานทางเทคนิคสามารถข้ามสรุปไปอ่านข้อกำหนดได้"

เอกสารประกอบแบบสองระดับมีประโยชน์มากกว่าการพยายามเขียนฉบับเดียวให้เหมาะกับผู้อ่านทั้งสองกลุ่มแต่ไม่ตอบโจทย์กลุ่มใดอย่างเพียงพอ

ทดสอบความรู้: พรอมต์สำหรับเอกสารประกอบทางเทคนิค

คุณกำลังเขียนพรอมต์เพื่อสร้างเอกสารประกอบเอพีไอสำหรับจุดปลายทาง 50 จุด ข้อกำหนดด้านคุณภาพที่สำคัญที่สุดคือ เอกสารต้องสะท้อนสิ่งที่เอพีไอทำจริงอย่างถูกต้อง ไม่ใช่สิ่งที่โมเดลจินตนาการว่าเอพีไอทำ วิธีใดช่วยรับรองความถูกต้องได้ดีที่สุด

ทบทวน: พรอมต์สำหรับเอกสารประกอบทางเทคนิค

เอกสารประกอบทางเทคนิคเป็นงานเขียนประเภทเฉพาะที่ต้องใช้ความแม่นยำ โครงสร้าง และน้ำเสียงแบบคำสั่งบุรุษที่สองสำหรับขั้นตอน พรอมต์ที่มีประสิทธิภาพจะระบุประเภทเอกสาร ส่วนที่ต้องมีตามชื่อ ข้อกำหนดของตัวอย่างโค้ด (ทำงานได้ในตัวเอง ใช้ชื่อตัวแปรที่สมจริง และระบุรุ่นภาษา) รวมถึงรูปแบบน้ำเสียงของเอกสารประกอบ

เทคนิคด้านความถูกต้องที่สำคัญที่สุดคือ จัดเตรียมโค้ดจริง ข้อกำหนดเอพีไอ หรือข้อมูลการกำหนดค่าเป็นข้อมูลป้อนเข้าเสมอ อย่าขอให้โมเดลแต่งรายละเอียดทางเทคนิคขึ้นมา และต้องมีการตรวจทานทางเทคนิคโดยมนุษย์ก่อนเผยแพร่เอกสารประกอบที่สร้างโดยปัญญาประดิษฐ์ทุกครั้ง

ในบทเรียนสุดท้าย คุณจะนำเทคนิคการเขียนพรอมต์ไปใช้กับเนื้อหาเชิงสร้างสรรค์และการเล่าเรื่อง

คำถามที่พบบ่อย

บทเรียน “พรอมป์ตสำหรับเอกสารทางเทคนิค” ฟรีหรือไม่

ใช่ — ข้อความเต็มของ “พรอมป์ตสำหรับเอกสารทางเทคนิค” ฟรีให้อ่านที่นี่บนเว็บ เพื่อปฏิบัติแบบโต้ตอบ (ตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7) และปลดล็อคส่วนที่เหลือของคอร์ส AI Prompt Engineering ให้อัปเกรดเป็น CoddyKit PRO คอร์ส AI Prompt Engineering มีบทเรียนทั้งหมด 4 บทเรียน

คุณจะเรียนรู้อะไรในบทเรียน “พรอมป์ตสำหรับเอกสารทางเทคนิค”

ไฟล์ README เอกสาร API และคู่มือวิธีใช้ด้วยภาษาทางเทคนิคที่ถูกต้อง คุณปฏิบัติ AI Prompt Engineering ด้วยโค้ดที่ใช้งานได้จริงที่คุณเรียกใช้โดยตรงในเบราว์เซอร์ และติวเตอร์ AI ตลอด 24/7 ตอบคำถามของคุณขณะที่คุณไปผ่านบทเรียน

คุณต้องมีประสบการณ์ก่อนที่จะเริ่มเรียน AI Prompt Engineering หรือไม่

ไม่จำเป็นต้องมีประสบการณ์มาก่อน AI Prompt Engineering บน CoddyKit ออกแบบมาสำหรับผู้เริ่มต้นไปจนถึงผู้เรียนขั้นสูง คุณสามารถเริ่มต้นที่นี่หรือเริ่มจากตัวแรกและเรียนด้วยความเร็วของคุณเอง นี่คือบทเรียนที่ 3 จากทั้งหมด 4 บทเรียน

บทเรียน “พรอมป์ตสำหรับเอกสารทางเทคนิค” ใช้เวลานานแค่ไหน

บทเรียน CoddyKit ส่วนใหญ่ใช้เวลาประมาณ 5–10 นาที แต่ละบทเรียนจึงสั้นและเป็นแบบโต้ตอบ คุณสามารถก้าวหน้าอย่างต่อเนื่องและกลับมาเรียนต่อจากตรงที่เพิ่งหยุดบนเว็บและแอปได้เลย

ฉันเขียนและรันโค้ดในบทเรียน AI Prompt Engineering นี้ได้ไหม

ได้ บทเรียน AI Prompt Engineering ทุกบทมีตัวแก้ไขโค้ดในตัว คุณจึงเขียนและรันโค้ดจริงได้เลยในเบราว์เซอร์ และได้รับข้อเสนอแนะจาก AI ในทันที — ไม่ต้องติดตั้งในเครื่องของคุณ

บทเรียนทั้งหมดในหลักสูตรนี้

พรอมป์ตสำหรับอีเมลและการเขียนเชิงมืออาชีพ
พรอมป์ตสำหรับเนื้อหาโซเชียลมีเดีย
พรอมป์ตสำหรับเอกสารทางเทคนิค
พรอมป์ตสร้างสรรค์และการเล่าเรื่อง

← กลับไปที่ AI Prompt Engineering