효과적인 테크니컬 라이팅용 프롬프트 엔지니어링 요건

• 미국 기술 기업인 Thoughtworks의 글로벌 기술 책임자인 Mike Mason가 제안하는 ‘테크니컬 라이팅에서 ChatGPT 결과물을 개선하는 전략’:

  1. 맥락을 설정한 프롬프트 사용하기
     • 작문 스타일, 맥락, 대상을 서술한 프롬프트를 만들고, 수정하며, 재사용하기
  2. 반복해서 작업하기
     • 생성형 AI가 첫 번째 시도에서 모든 걸 제대로 구현하지 못할 수 있음
     • 인내심을 갖고, AI가 올바른 방향으로 나아가도록 시간을 들이며, 반복 작업으로 결과물 개선하기

• 영국 지식 기반 문서화 플랫폼 기업인 Document360이 제시하는 ‘테크니컬 라이터가 프롬프트 엔지니어링에 숙달하기 위해 따라야 할 단계’:

  1. 프롬프트를 테스트하고, 조정하기
     • 프롬프트를 하나만 입력해서 최종 결과물이 나오지 않음
     • 기술 문서 측면에서 사용자에게 적합한 응답을 얻도록 프롬프트를 테스트하기
     • 여러 버전으로 이를 반복해서 테스트하기
  2. 맥락과 사용 사례를 제공하기
     • 문서가 유용하려면 맥락이 있어야 하고, 특정 사용 사례를 대상으로 삼아야 함
     • AI는 프롬프트 뒤에 숨은 사용자 의도를 인식하지 못함
     • LLM에 문서 관련 프롬프트를 입력할 때, 정확하게 메시지를 전달하기

• 미국 생산성 플랫폼 기업 기업인 ClickUp이 제안하는 ‘테크니컬 라이팅에서 ChatGPT를 효과적으로 사용하는 방법’:

  1. 기술 용어와 정의를 포함해 글 쓰려는 주제와 관련해 가능한 많은 정보를 제공하기
  2. 테크니컬 라이팅의 목표가 분명해야 사용자의 특정 수요와 일치하는, 가장 맞춤화되고 정확한 조언을 얻을 수 있음
  • AI가 생성한 콘텐츠 품질을 개선하는 방법:
    • 당면한 기술 주제에 집중해 구체적이고 자세한 프롬프트 사용하기
    • 더 정확한 결과를 얻으려면 다양한 구와 문장 구조를 사용해 실험하기

• 미국 테크니컬 라이팅 교육 서비스인 ‘Technical Writer HQ’의 창업자인 Joshua Gene Fechter가 제안하는 테크니컬 라이팅 관련 프롬프트:

  1. 애자일, 스크럼, 워터폴과 같이 다양한 소프트웨어 개발 방법론을 비교하고 대조하며, 프로젝트를 관리할 때 각각의 장단점을 논하세요(Compare and contrast different software development methodologies, such as Agile, Scrum, and Waterfall, and discuss their respective advantages and drawbacks in managing projects)
  2. 마이크로서비스 아키텍처의 기본 개념과 장단점을 설명하고, 마이크로서비스 기반 애플리케이션을 설계하고 구현하며 규모를 확장하는 방법의 단계별 가이드를 써주세요(Explain the fundamental concepts of microservices architecture, including its advantages and drawbacks, and provide a step-by-step guide on how to design, implement, and scale a microservices-based application)
  3. 핵심 기능, 명령어, 워크플로, 팀 환경에서 효과적인 협업과 갈등 해결 전략에 중점을 둔 Git 마스터 가이드를 작성하세요(Create a guide to mastering Git, focusing on key features, commands, and workflows, as well as strategies for effective collaboration and conflict resolution in a team setting)
  4. 이 콘텐츠의 명확성과 간결성을 평가해 복잡한 전문 용어나 긴 설명을 단순화하고, 평이한 언어로 대체하거나, 가독성을 향상하기 위해 ‘관리할 수 있는 섹션으로 세분화할 수 있는 부분’을 찾아보세요(Evaluate this content for clarity and conciseness, identifying areas where complex jargon or lengthy explanations can be simplified, replaced with plain language, or broken down into more manageable sections for improved readability)
  5. 이 콘텐츠가 용어를 일관되게 사용하는지 검토하고, 모든 기술 용어, 머리글자와 약어가 처음 사용할 때 정의되며 문서 전반에 걸쳐 일관되게 적용돼 혼동을 피하게 하세요(Review this content for consistent use of terminology, ensuring that all technical terms, acronyms, and abbreviations are defined upon first use and are applied consistently throughout the document to avoid confusion)
  6. 이 콘텐츠가 도표, 업무 흐름도, 스크린샷과 같이 시각 자료를 효과적으로 사용해 텍스트 내용을 보완하고 명확하게 하는지 검토하고, 콘텐츠에서 모든 시각 자료가 적절하게 레이블링 되고 캡션이 달렸으며 참조를 표시하게 하세요(Examine this content for effective use of visuals, such as diagrams, flowcharts, and screenshots, to supplement and clarify the text, ensuring that all visuals are properly labeled, captioned, and referenced in the content)
  7. 이 콘텐츠에서 문법, 구두점, 맞춤법을 점검하고, 문서의 전문성과 신뢰성을 떨어뜨리는 오류와 불일치를 수정하세요(Check this content for proper grammar, punctuation, and spelling, addressing any errors or inconsistencies that may detract from the document's professionalism and credibility)
  8. 이 콘텐츠의 어조와 목소리가 적절한지 분석하고, 이게 대상 고객의 기대와 조직의 브랜드 가이드라인, 문서 목적과 잘 맞으며, 명확하고 이해하기 쉬우면서 권위 있는 스타일을 유지하게 하세요(Analyze this content for appropriate tone and voice, ensuring that it aligns with the target audience's expectations, your organization's brand guidelines, and the purpose of the document while maintaining a clear, approachable, and authoritative style)
  9. 이 콘텐츠의 정보가 정확하고 최신 상태인지 검토하고, 모든 사실과 수치, 사례를 확인하며, 웹사이트와 기사, 코드 리포지터리 같은 모든 외부 리소스가 적절하게 인용되고 링크돼 있도록 하세요(Review this content for accurate and up-to-date information, verifying all facts, figures, and examples, and ensuring that all external resources, such as websites, articles, or code repositories, are properly cited and linked)
  10. 이 콘텐츠가 예시와 사례 연구를 효과적으로 사용하는지 검토하고, 이게 명확하고 관련성 있으며 콘텐츠에 잘 통합돼 청중에게 핵심 개념과 기술을 설명하는 데 도움이 되도록 하세요(Examine this content for effective use of examples and case studies, ensuring that they are clear, relevant, and well-integrated into the content to help illustrate key concepts and techniques for your audience)