본문으로 건너뛰기
BigTree108

기술 문서 작성 서비스

소프트웨어 기업을 위한 기술 문서 작성 서비스입니다. API 레퍼런스, 개발자 가이드, 사용자 문서, 런북, 릴리스 노트를 제품 옆에 코드처럼 작성하고 릴리스마다 최신 상태로 유지합니다.

테크니컬 라이터 업무 범위

  • API 문서

    OpenAPI 또는 GraphQL 스키마에서 생성한 레퍼런스에 시작 가이드, 인증 안내, 실행 가능한 예제를 덧붙여 작성하므로 레퍼런스를 손으로 편집하는 일이 없습니다.

  • 코드형 문서

    귀사의 저장소에 Markdown으로 문서를 두고 코드처럼 풀 리퀘스트에서 검토하며, 제품과 같은 파이프라인에서 Docusaurus, Starlight 또는 유사한 생성기로 게시합니다.

  • 사용자 가이드와 헬프 센터

    독자가 하려는 일에 따라 정리한 작업 중심 가이드와 헬프 센터 문서를 Diátaxis 프레임워크에 따라 튜토리얼, 방법 안내, 레퍼런스, 설명으로 나눕니다.

  • 런북과 운영 가이드

    배포, 복원, 사고 대응, 당직을 위한 단계별 절차를 작성하지 않은 사람이 직접 따라 하며 테스트합니다.

  • 릴리스 노트와 변경 이력

    사용자에게 무엇이 바뀌었는지 알려 주는 릴리스 노트와 통합 담당자를 위한 변경 이력을 병합된 풀 리퀘스트로 초안을 만들고 릴리스와 대조해 확인합니다.

  • 스타일 및 품질 점검

    파이프라인에서 Vale로 검증하는 스타일 가이드와 용어집, 빌드마다 실행하는 깨진 링크 검사로, 일관성이 한 명의 검토자에게 좌우되지 않습니다.

테크니컬 라이터 채용

  • 귀사 팀의 풀타임 인력

    귀사의 근무 시간에 맞춰 귀사의 도구와 회의에서 일하고 귀사의 리드에게 보고하는 테크니컬 라이터 인력이며, 우크라이나 현지 계약, 급여, 휴가는 당사가 맡습니다.

  • 파트타임 또는 부분 투입

    업무가 분명히 있지만 아직 풀타임 직무는 아닐 때, 주당 정해진 일수만 투입하는 테크니컬 라이터 인력입니다.

  • 프로젝트 또는 출시를 위해

    첫 주부터 인수인계까지 정해진 기간의 업무를 위한 테크니컬 라이터 인력이며, 종료일은 사전에 합의합니다.

전담 개발팀 페이지는 전문가가 귀사 팀에 합류하는 방식을 설명하고, 외주 개발 페이지는 프로젝트 납품, 인수, 비용 청구 방식을 다룹니다.

당사 테크니컬 라이터 인력이 함께 일하는 사람들

  • 엔지니어와 기술 리드

    인터뷰, 검토, 기술적 정확성

  • 프로덕트 매니저

    기능, 대상 독자, 릴리스 범위

  • 기술 지원 엔지니어

    사용자가 실제로 묻는 질문

  • UI 및 UX 디자이너

    인터페이스 문구와 다이어그램

당사 테크니컬 라이터의 업무 방식

문서는 코드가 있는 곳에 둡니다. 저장소 안에서 문서가 설명하는 변경과 같은 풀 리퀘스트로 검토하고, 파이프라인이 빌드해 게시합니다. 문서가 병합되어야 기능이 완료된 것이므로 문서는 코드만큼 최신 상태를 유지합니다.

집필은 독자에서 출발합니다. 독자가 누구이고, 무엇을 하려 하며, 이미 무엇을 알고 있는지를 먼저 파악합니다. 지원 티켓과 검색어는 현재 문서가 어디에서 부족한지 보여 주며, 그런 페이지부터 고칩니다.

그 밖의 제공 역할

팀 직무 개요

테크니컬 라이터 채용 관련 질문

아무도 문서화하지 않은 시스템도 테크니컬 라이터가 문서화할 수 있습니까?

네. 테크니컬 라이터가 코드와 설정을 읽고 엔지니어를 인터뷰하여 아키텍처 개요, 런북, 용어집을 작성하며, 시스템을 운영하는 담당자가 이를 검토합니다. 이는 당사가 인계받은 시스템을 인수할 때 가장 먼저 수행하는 읽기 전용 검토 단계와 같습니다.

API 문서가 API와 어긋나지 않도록 어떻게 관리합니까?

레퍼런스는 빌드 과정에서 OpenAPI 또는 GraphQL 스키마로 생성하므로 API와 어긋날 수 없습니다. 생성기가 만들 수 없는 부분, 즉 시작 가이드, 인증 안내, 레퍼런스를 활용하기 전에 개발자에게 필요한 예제는 테크니컬 라이터가 보완합니다.

테크니컬 라이터 투입까지 얼마나 걸립니까?

적합한 테크니컬 라이터 인력이 있으면 귀사의 면접, NDA, 지식재산권 양도 절차만 거치면 바로 시작할 수 있습니다. 그렇지 않으면 인재를 탐색하며, 보통 2~3주 안에 후보자 프로필을 전달합니다. 귀사가 승인하기 전에는 누구도 업무를 시작하지 않습니다.

테크니컬 라이터 채용은 BigTree108을 통해 어떻게 진행합니까?

필요한 업무, 경력 수준, 근무 시간을 알려 주십시오. 당사가 한두 명의 프로필을 제안하면, 귀사는 직접 채용하는 인력과 같은 방식으로 면접을 진행하고, BIG TREE 108 LLC와 하나의 계약을 체결하여 월 1회 하나의 인보이스를 받습니다.

전문가가 만든 결과물의 소유권은 누구에게 있습니까?

귀사에 있습니다. 모든 전문가는 당사와 서명한 계약으로 모든 작업 결과물을 회사에 귀속시키고, 귀사와의 계약으로 이것이 다시 귀사에 귀속됩니다. 코드, 디자인, 문서는 당사만 수정할 수 있는 곳이 아니라 귀사의 저장소와 도구에 직접 전달합니다.

문서가 제품을 따라가지 못하고 있습니까?

제품, 독자, 그리고 현재 문서를 관리하는 위치를 알려 주십시오. 영업일 기준 1일 이내에 후보자 프로필 또는 문서화 계획으로 답변드립니다.

이메일 hello@bigtree108.com응답 방식