TODOCS 자리 표시자 사용하기
기술 문서 작성자는 때때로 나중에 다시 확인하거나 작성할 내용을 기억하기 위해 자리 표시자를 사용합니다. 유용한 기술이지만 플레이스홀더가 간과되어 누락되어 생산 단계까지 넘어갈 가능성이 항상 존재합니다. 이 시점에서 Docs 팀이 이를 확인할 수 있는 유일한 방법은 누군가가 이를 보고 보고하는 것입니다.
슬립을 방지하려면 문자열 TODOCS을 개체 틀로 사용합니다. Docs 테스트 도구 모음에는 Markdown 또는 YAML 파일에서 이 문자열을 찾으면 실패하는 Linting 테스트가 포함되어 있습니다.
참고
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.