leter/zh-tech-writing

해결하는 문제

중국어 기술 문서에서 "AI 스타일" 글쓰기를 제거합니다. 많은 LLM이 생성하는 텍스트는 지나치게 장황하고 마케팅 용어로 가득 차 있으며 엔지니어에게 부자연스러운 반복적인 문장 구조를 사용합니다. 이 프로젝트는 기술 문서(README, 설계 문서, API 사양, 튜토리얼)가 간결하고 사실적이며 전문적이도록 보장하는 규칙 세트와 워크플로우를 제공합니다.

작동 방식

Claude Code와 같은 도구와 호환되는 "Agent Skill"로 구현됩니다. AI를 특정 작성 프로세스로 안내합니다:

1. 대상 독자 정의: 대상 독자와 원하는 결과를 식별합니다.
2. 규칙 기반 초안 작성: 문장 길이(절당 20자 미만), 능동태, 직접적인 동사에 대한 엄격한 규칙을 적용합니다.
3. AI 스타일 제거: 14개 항목의 "AI 스타일 체크리스트"를 사용하여 진부한 표현, 마케팅 형용사, 번역체 표현을 식별하고 제거합니다.
4. 자동 서식: autocorrect 도구와 통합하여 중국어와 영어 문자 사이의 간격을 자동으로 수정하고 구두점을 수정합니다.
5. 수동 다듬기: 따옴표와 줄임표 같은 특정 기호에 대한 최종 검사를 수행합니다.

대상 사용자

AI가 생성한 중국어 문서가 일반적인 AI 어시스턴트가 아닌 인간 엔지니어가 작성한 것처럼 들리기를 원하는 개발자와 기술 문서 작성자.

주요 특징

• 사실 기반: 모호한 형용사(예: "강력한", "매끄러운")를 구체적인 사실, 숫자, 오류 메시지로 대체합니다.
• 표준화: Ruan Yifeng의 중국어 기술 문서 스타일 가이드와 같은 확립된 지침을 기반으로 합니다.
• 도구 통합: skills CLI와 호환되며 autocorrect를 통한 자동 구두점 수정을 지원합니다.
• 사용자 정의 가능한 워크플로우: 파일을 직접 다시 쓰거나 "원본 → 수정 → 이유" 형식의 개선 제안 목록을 제공하는 데 사용할 수 있습니다.