API 작성기
API writer |
API 작성자는 API(응용프로그램 인터페이스)를 기술하는 문서를 작성하는 기술 작성자다. 주요 청중은 프로그래머, 개발자, 시스템 설계자 및 시스템 설계자를 포함한다.
개요
API는 소프트웨어 응용프로그램을 구축하기 위한 인터페이스, 기능, 클래스, 구조, 열거 등으로 구성된 라이브러리다. 개발자들이 소프트웨어와 상호작용하고 확장하기 위해 사용한다. 주어진 프로그래밍 언어 또는 시스템에 대한 API는 시스템 정의 구조와 사용자 정의 구조로 구성될 수 있다. 이러한 구성의 수와 복잡성이 증가함에 따라, 개발자들은 모든 기능과 정의된 매개변수를 기억하는 것이 매우 지루해진다. 따라서 API 작성자는 소프트웨어 응용프로그램을 구축하는 데 핵심적인 역할을 한다.
기술적 주제 때문에 API 작성자는 API 문서가 요구하는 정보를 추출할 수 있을 정도로 응용프로그램 소스 코드를 이해해야 한다. API 작성자는 종종 프로그래머가 소스 코드에 배치한 소프트웨어 문서를 구조적으로 추출하여 코멘트와 그들이 문서화한 프로그래밍 구성물 사이의 관계를 보존하는 툴링을 사용한다.
API 작성자는 또한 소프트웨어 제품을 이해하고 새로운 소프트웨어 릴리스의 일부로 새로운 기능이나 변경사항을 문서화해야 한다. 소프트웨어 출시 일정은 조직마다 다르다. API 작성자는 소프트웨어 라이프사이클을 잘 이해하고 시스템 개발 라이프사이클(SDLC)에 통합할 필요가 있다.
미국의 API 작성자들은 일반적으로 문법과 구두점을 위해 시카고 스타일 매뉴얼을 따른다.[citation needed]
자격 요건들
API 작성자는 일반적으로 프로그래밍과 언어 기술이 혼합되어 있다. 많은 API 작성자들은 프로그래밍이나 기술 쓰기에 경험이 있다.
- 컴퓨터 프로그래밍 배경(C, C++, Java, PHP 또는 기타 프로그래밍 언어의 지식)
- Doxygen, Javadoc, OpenAPI 또는 DITA와 같은 형식 지정 표준에 대한 지식
- FrameMaker와 같은 편집기 및 도구에 대한 지식
- 개발자와 상호 작용하기 위한 뛰어난 커뮤니케이션 및 쓰기 기술
전문가 API/소프트웨어 개발 키트(SDK) 작성자는 쉽게 프로그래밍 작성자가 될 수 있다.
API 쓰기 프로세스
API 쓰기 프로세스는 일반적으로 소스 코드 분석과 이해, 계획, 작성, 검토로 나뉜다. 분석·기획·작성 단계가 엄격히 선형적으로 발생하지 않는 경우가 많다.
작성기준과 평가기준은 기관마다 다르다. 가장 효과적인 API 문서 중 일부는 특정 애플리케이션의 작업을 충분히 이해할 수 있는 사람들이 작성한 것으로, 소프트웨어를 사용자나 다양한 구성요소 구조와 프로그램의 전체적인 목적에 연관시킬 수 있다. API 작성자는 최종 사용자 제품 설명서 작성도 책임질 수 있다.
참조 문서는 완전성을 보장하기 위해 자동 생성될 수 있지만, 개발자의 시작을 돕는 문서는 전문 API 작성자가 작성하고 주제 전문가가 검토해야 한다.[1] 이를 통해 개발자가 주요 개념을 이해하고 신속하게 시작할 수 있도록 보장할 수 있다.
제품
API 작성자는 다음을 포함하는 문서를 작성한다.
- API 참조 가이드
- 프로그래머의 안내서
- 개발자 설명서
- 관리 매뉴얼
- 설치 안내서
- 구현 및 통합 가이드
참고 항목
참조
- ^ Jacobson, Daniel (2011). APIs : a strategy guide. O'Reilly. p. 101. ISBN 9781449321642.
