Plugins

Sigcraft Plugin Documentations

플러그인 개발자 용 Documentation 입니다.

이 Docs는 다음을 목적으로 합니다.

1. 개발자 본인이 플러그인에 대한 내용을 까먹는 것을 방지

2. 다른 개발자가 구조를 파악할 때 최소한의 도움을 제공

따라서 기본적으로 Domain 별로 서술 되며, 다음의 내용을 H2로 순서대로 포함합니다.

1. Domain의 기본 개념, Mental model

2. Reason - Domain의 필요성, 존재 이유, 목적

3. Usage - 기본적인 사용 방법, 예시 코드를 포함할 것을 권장

4. Feature - 기능 설명, 하위 구성 요소 설명

5. Sections(Custom) - 모듈마다 필요한 Section, 이름은 각자 다르고 여러 개 존재 가능합니다.

6. Caution - 사용 상 주의 사항, Known Issue

그리고, 다음의 제약 조건을 따릅니다.

• 이 내용은 코드와 동시에 업데이트 되어야 합니다.

• 내용은 최대한 간략하게 표현되어야 합니다. 길면 길수록 읽거나 관리하기 어렵습니다.

• JavaDoc 혹은 파일 자체에 적을 수 있는 내용은 그곳에 적는 것을 우선으로 합니다. 문서와 중복되는 것을 권장하지 않습니다.

• 글보다 코드를 우선시합니다. 백문이 불여일코드입니다.

• 영문보다 한글을 우선시합니다.

• 추후에 Docs에 업데이트가 되지 않을 사항으로 보이는 서술은 적지 않습니다. (예: ~는 언제 업데이트 될 것으로 생각됨, 추후 변경 가능, 특정 class 등 코드 전체)

• 가능한 경우 주의 사항은 해당 위치에 Hint 로서 표기합니다. 어느 위치에도 적기 어려운 주의 사항이 Caution 문단에 들어갈 수 있습니다.