Techwrite는 복잡한 기술 개념을 개발자와 이해관계자를 위한 실행 가능하고 정밀한 산문으로 변환하는 전문가급 문서화 엔진입니다.
설치 및 다운로드
1. ClawHub CLI
레지스트리에서 스킬을 바로 설치하는 가장 빠른 방법입니다.
npx clawhub@latest install techwrite
2. 수동 설치
스킬 폴더를 다음 위치 중 하나로 복사하세요
~/.openclaw/skills/ <project>/skills/ 우선순위: 워크스페이스 > 로컬 > 번들
3. 프롬프트 설치
이 프롬프트를 OpenClaw에 복사하면 자동으로 설치됩니다.
Clawhub를 사용해서 techwrite 설치를 도와줘. Clawhub가 설치되어 있지 않다면 먼저 설치해 줘 (npm i -g clawhub).
다운로드를 원하시나요?
ZIP 아카이브 형태의 원본 스킬 파일을 받으세요.
Techwrite: 심층 기술 작문 워크플로우란 무엇인가요?
Techwrite는 AI 에이전트가 우수한 기술 문서를 생산하도록 설계된 전문화된 워크플로우입니다. 단순한 단어 수에서 명확성, 정확성 및 적절한 깊이로 초점을 전환합니다. 이 Openclaw Skills 자산을 활용함으로써 개발자는 내부 RFCs, 공개 API 참조 또는 복잡한 마이그레이션 가이드를 작성할 때 문서가 훑어보기 쉽고 정직하며 특정 독자 페르소나에 맞춰져 있는지 확인할 수 있습니다.
이 스킬은 모호한 대명사와 숨겨진 가정과 같은 일반적인 문서화 함정을 방지하는 엄격한 6단계 라이프사이클을 시행합니다. '수행해야 할 작업(job-to-be-done)'을 우선시하여 모든 콘텐츠가 독자가 혼란 없이 자신 있게 행동하거나 결정할 수 있는 구체적인 성공 결과로 이어지도록 보장합니다.
Techwrite: 심층 기술 작문 워크플로우 활용 사례
- 신규 기능을 위한 포괄적인 API 참조 및 통합 가이드 작성.
- RFCs (Request for Comments) 및 ADRs (Architecture Decision Records)와 같은 중요 엔지니어링 문서 생성.
- 훑어보기 쉬운 런북(runbooks), 사후 분석(postmortems) 및 개발자 온보딩 문서 작성.
- 명확성을 높이고 산문의 기술 부채를 제거하기 위해 기존 기술 페이지 개선.
- 지원 티켓을 줄이기 위한 문제 해결 테이블 및 예외 케이스 문서 생성.
Techwrite: 심층 기술 작문 워크플로우 작동 원리
- 청중 및 목표 정의: 콘텐츠가 집중되도록 단일 기본 독자 페르소나와 특정 수행 작업을 식별하는 것부터 시작합니다.
- 개요 및 범위 지정: BLUF (Bottom Line Up Front) 원칙을 사용하여 문서를 구조화하고 섹션을 독자의 멘탈 모델에 매핑합니다.
- 핵심 콘텐츠 초안 작성: 모호한 형용사를 피하고 처음 사용할 때 기술 용어를 정의하면서 정확하고 능동적인 문장을 생성합니다.
- 예제 및 예외 케이스: 사용자 신뢰를 구축하기 위해 최소한의 완전한 코드 스니펫과 현실적인 실패 시나리오를 통합합니다.
- 명확성 검토: 모호한 대명사를 제거하고 모든 다이어그램과 링크가 작동하고 접근 가능한지 확인하기 위해 정밀한 편집을 수행합니다.
- 유지 관리 계획: 시간이 지남에 따라 문서가 노후화되는 것을 방지하기 위해 소유권 및 검토 주기를 설정합니다.
Techwrite: 심층 기술 작문 워크플로우 설정 가이드
Techwrite를 환경에 통합하려면 Openclaw Skills 러너가 설치되어 있는지 확인한 다음 에이전트 라이브러리에 techwrite 정의를 추가하세요.
# 로컬 저장소에 techwrite 스킬 추가
openclaw skills add techwrite
# AI IDE 또는 CLI 내에서 워크플로우 트리거
/skill techwrite "새로운 인증 모듈에 대한 API 가이드 작성"
Techwrite: 심층 기술 작문 워크플로우 데이터 스키마 및 분류 체계
Techwrite는 대규모 문서 세트 전체의 일관성을 유지하기 위해 문서 데이터를 구조화된 분류 체계로 정리합니다.
| 속성 | 설명 | 형식 |
|---|---|---|
| 성공 문구 | 독자를 위한 명시적 결과 | String |
| 페르소나 | 대상 독자 (예: SRE, 신입 사원) | Taxonomy Key |
| BLUF | 핵심 내용 요약 (Bottom Line Up Front) | Markdown Block |
| 절차적 단계 | 번호가 매겨진 작업 순서 | Ordered List |
| 메타데이터 | 버전 관리, 소유자 및 최종 검토 날짜 | YAML Frontmatter |
Techwrite: 심층 기술 작문 워크플로우 고급 기능
- 다단계 반복 지원: 거친 개요에서 세련되고 배포 준비가 된 산문으로 원활하게 이동합니다.
- 템플릿 통합: 조직 스타일 가이드 또는 특정 문서 템플릿을 수집하고 따르는 기능.
- 정밀 편집: 원저자의 목소리를 보존하면서 기존 초안을 개선합니다.
- 접근성 가드레일: 다이어그램의 alt-text 및 안정적인 URL 구조에 대한 자동 확인.
- 전략적 중단: 진화하는 플랫폼을 위한 리다이렉트 및 페이지 기록 처리 지침.
SKILL.md
로드 중
관련 Openclaw 스킬
Serverless Deep Workflow
AWS Lambda, Azure Functions 및 Google Cloud Functions 전반에서 복원력 있는 서버리스 워크로드를 설계, 디버깅 및 확장하기 위한 포괄적인 6단계 프레임워크입니다.
Risk Assessment 기술
프로젝트의 불확실성을 우선순위가 지정된 완화 조치와 책임 있는 소유권으로 전환하는 심층 리스크 평가를 위한 전문 프레임워크입니다.
Retro AI 사후 분석 워크플로우
시스템 장애를 실행 가능한 신뢰성 개선으로 전환하기 위해 설계된 포괄적인 비난 방지 사후 분석 프레임워크입니다.
Content Repurposer
Content Repurposer는 긴 기사, 블로그, 스크립트를 LinkedIn, Twitter, Instagram에 최적화된 간결한 소셜 미디어 포스트로 변환합니다.
Minijuegos LeChuck SDK 통합
플레이어 인증, 업적 및 영구 게임 통계를 처리하기 위한 Minijuegos.com LeChuck JS SDK의 포괄적인 통합 가이드입니다.
Agent Browser
접근성 트리 스냅샷을 사용하여 결정론적 요소 상호작용을 구현하는 AI 에이전트용 고성능 헤드리스 브라우저 CLI입니다.
추천*
