TODOCS 개체 틀 사용
때로는 기술 작성자가 문서를 작성하는 동안 개체 틀을 사용하여 나중에 무언가로 돌아오도록 상기시킵니다. 유용한 기술이지만 개체 틀이 간과되어 프로덕션으로 전환될 가능성이 항상 있습니다. 이 시점에서 Docs 팀이 이를 확인할 수 있는 유일한 방법은 누군가가 이를 보고 보고하는 것입니다.
슬립을 방지하려면 문자열 TODOCS을 개체 틀로 사용합니다. Docs 테스트 도구 모음에는 Markdown 또는 YAML 파일에서 이 문자열을 찾으면 실패하는 Linting 테스트가 포함되어 있습니다.
Note
VS Code을 텍스트 편집기로 사용하는 경우 “TODO 하이라이트” 확장은 파일에서 “TODOCS” 인스턴스를 강조 표시하는 데 유용합니다. 이 확장의 설정에 "TODOCS" 및 기타 대/소문자 종류(예: "todocs")를 추가합니다.
예제
1. In the dropdown, select the settings you want to sync.
TODOCS: ADD A SCREENSHOT OF THE SETTINGS SYNC OPTIONS
1. Click **Sign in & Turn on**, then select the account to which you want your settings to be synced.