CodeMaru
포트폴리오로 돌아가기
공개 활동

Technical Documentation Studio

개발 산출물을 읽기 쉬운 문서와 배포 가능한 설명으로 정리

Technical WritingREADMEAPI DocsRelease NotesMarkdownProposalDeveloper Experience
2023.06 ~ PresentTechnical Writing AssistantDocumentation Support

소개

README, API 문서, 설치 가이드, 릴리즈 노트, 제안서 초안을 프로젝트 목적과 독자 수준에 맞춰 빠르게 구성하는 기술 문서 작성 보조 프로젝트.

주요 성과

  • 프로젝트 구조와 기능 설명을 바탕으로 README와 설치 가이드 초안 작성
  • API 사용 흐름, 요청·응답 예시, 에러 케이스를 문서 섹션으로 구성
  • 변경 내역을 사용자 관점 릴리즈 노트와 개발자 관점 changelog로 분리
  • 기획서, 제안서, 포트폴리오 설명 문구를 목적에 맞춰 재작성

활용 도구 및 역량

Markdown, API Documentation, Release Notes, Specification Drafting, Editing