Documentation 작성법

 

API Dcoumentation 작성

목적 : 프론트엔드 개발자와 동료 백엔드 개발자에게 내가 생성한 API가 어떻게 동작하는지 설명함. 

문서화방식 :  txt파일로 생성시에, 변경사항 추적이 어려우며 swagger,OPENAPI와 같은 전용툴을 사용함.

 

Swagger사용법

 

1. 스프링 환경설정  

Dependency추가

implementation 'io.springfox:springfox-boot-starter:3.0.0'

implementation 'io.springfox:springfox-swagger-ui:3.0.0'

 

Properties추가

spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER

 

2. 스프링 Configuration 추가

스프링 전체 Class에 영향을 주는 것이기 때문에 Configuration으로써 등록한다.

 

 

 

 

Readme 작성

Markdown 이란?

일반 텍스트 형식의 문서의 양식을 편집하는 문법 누구나 쉽게읽고 쓸수있으며 완성후 HTML으로 쉽게 변환되어 보여진다.
특수기호와 문자를 이용한 매우 간단한 구조의 문법을 사용해 빠르게 작성하고 쉽게 읽을 수 있다.

StackOverflow, Discord, Reddit, GitHub에서 두루두루 사용됨.

 

Markdown 태그의 종류

-제목 h1 : #,=====

- 소제목 h2 : ##

- 소제목 h3 : ###

- 가로경계선 생성 : ----- , ***** , +++++

 

- UnorderedList : -

- Indented Unordered List : (blank space) - 

 

- 볼드체 : **내용**

- 이탤릭체 : 

-인용 : >
-강조:*,_

 

- 링크 : [텍스트](주소 "설명 생략가능")
- 이미지 :  -리스트:1,*,-,+

- 코드표시 : <code>코드</code> , 한줄 띄우고 스페이스 4칸 , ```코드``` -줄바꿈:엔터2번,강제줄바꿈은문장끝에스페이스바2칸

 

“프로젝트를 설명하는 문서”

어떠한 목적으로 개발되었는지, 코드의 개요, 코드의 구조, 빌드 방법, 사용법 등을 마크다운으로 작성한다.

 

 

마크다운문법 공식문서 : https://www.markdownguide.org/

 

• 프로젝트 구성
• 프로젝트 프로그램 설치방법
• 프로젝트 프로그램 사용법
• 저작권 및 사용권 정보
• 프로그래머 정보
• 버그 및 디버그
• 참고 및 출처
• 버전 및 업데이트 정보
• FAQ

 

https://backendcode.tistory.com/165

https://medium.com/@ruccess0.0/readme-%EC%93%B0%EB%8A%94%EB%B2%95-380a8b6c78b5

https://velog.io/@luna7182/%EB%B0%B1%EC%97%94%EB%93%9C-%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-README-%EC%93%B0%EB%8A%94-%EB%B2%95