[WritingConvention]글쓰기 규약

Philip Sung·2023년 1월 20일
0

[WritingConvention]

목록 보기
1/4
post-thumbnail

01 개요

작성한 개발 기록물 등의 구성을 최대한 표준화 하여 이후 데이터 처리 시 조금 더 용이하게 다룰 수 있도록 문서 양식을 정한다.

최종수정일 : 2023.01.20




02 메타데이터

글은 주제에 따라 아래 메타데이터를 가지고 작성하며, 지나치게 길어질 경우 "글제목 - 1"의 형태로 나눌 수 있다.
글 제목 : 미완성 글일 시 맨 앞에 * 추가한다.
태그 : 시리즈를 가장 앞에 달고, 프로그램명, 언어명, 내용 등에 대해 자유 형식으로 상세하게 추가한다.
소개글 : 최종수정일까지만 표기한다.
공개설정 : 미완성 글(*)인 경우 비공개한다.
URL : 제목을 카멜케이스 표기법으로 간략히 적는다.
시리즈 설정 : 알맞은 시리즈로 설정한다.
최종수정일 : 개요부분 아래에 0000.00.00의 형태로 적는다.




03 순서

03.01 글 간 순서

시리즈 내에서는 종류나 작성 날짜에 관계없이 글의 난이도가 높은 것이 위로 오도록 배치한다.
난이도와 상관이 없는 경우 작성일이 최근인 것이 위로 오도록 배치한다

03.02 내용 간 순서

01 개요

01.01 중분류

01.01.01 소분류

본문



02 대분류

...




04 문단기호

04.01 문단 구분

<br><br>
***




05 교정부호

교정부호의미
(*.kor)한글로 번역하여 적으려 했으나 적절한 말을 찾지 못하여 임시로 영어로 가져다 쓴 경우
profile
Philip Sung

0개의 댓글