Qiita 기사 게시물의 문서 기법

소개

고생하고 쓴 Qiita 기사를 조금이라도 많은 사람에게 전달하기 위한, 약간의 테크닉의 정리입니다. 항상 잊어 버리기 때문에 절반은 개인 메모입니다. 직접 프로그래밍에는 관계 없습니다만, 문서 작성 기술도 소프트웨어 기술의 1부라고 하는 것으로 용서해 주세요.

Markdown이나 이모티콘을 사용하고 싶습니다.

기사를 각 화면의 오른쪽 상단에 이모티콘 아이콘과 도움말 아이콘이 있습니다. 잊어버렸을 때 상당히 편리합니다.



이모티콘에 대한 자세한 내용은 EMOJI CHEAT SHEET, Qiita/Github/Slack/Discord 이모티콘 목록을 참조 할 수 있습니다.

또, 헬프(?마크의 아이콘) 링크처의 Markdown 기법 치트 시트 는 한 번은 눈을 통해 두면 좋다고 생각합니다. 뭔가 새로운 발견이 있을까 생각합니다.

테이블 완성

Markdown 기법 치트 시트 에 써 있습니다만, 테이블 만들고 싶을 때 편리합니다. 3x2라든가 만들고 싶은 테이블의 사이즈를 입력하는 것만으로, 마음대로 베이스를 만들어 줍니다.


이 애니메이션 GIF는 Markdown 기법 치트 시트의 인용입니다.

GitHub의 리포지토리에 대한 링크를 눈에 띄게

GitHub의 리포지토리에의 링크는, 아래와 같이 OGP같은 링크를 붙이면 눈에 띄어 좋습니다.


GitHub Link Card Creator 라는 서비스를 사용하는 것으로 실현할 수 있습니다.

사용법은 간단하고 <GitHub user name>/<GitHub repository name> 를 입력하면 됩니다. 위의 링크라면 karaage0703/uonome 입니다.

작자에 의한, 서비스 작성의 경위등은 이하 기사 참조해 주세요.

모두에게 OSS를 보고 싶은 사람을 위해 GitHub 리포지토리의 OGP적 이미지를 자동 생성해 주는 서비스를 만들었다

다른 사람이 쓴 좋은 것 같은 Qiita 기사의 소스를 본다

금단의 기술? 수 있습니다. Qiita에 로그인해야 합니다. 로그인하지 않고 보는 방법을 Twitter에서 가르쳐 주셨습니다.

「아, 이 Qiita 기사 멋진… 이것은 사랑일지도. 더 이 기사를 알고 싶다!」

라고 생각하면, 러브레터가 아닌 편집 리퀘스트를 보내 봅시다. 기사의 오른쪽 상단에서 "..."를 클릭하면 아래와 같이 나오는 "편집 요청 보내기"를 클릭합니다.

라고 생각하면, 기사의 오른쪽 상단의 「…」를 클릭하면, 아래와 같이 나오는 「Markdown에서 본문을 본다」를 클릭합니다.



　그러면, 다시 이상한(?) Qiita 기사의 소스가 알몸! 참고로 버리자!

물론, 인용을 넘는 범위의 카피는 안됩니다. 조심하세요.

수식

Qiita에서는 수식도 사용할 수 있습니다. 자세한 내용은 아래를 참조하십시오.

기계 학습 관계의 논문을 읽고 쓰는 수식 및 기호 요약

요약

Qiita에 기사 투고할 때의, 약간의 다큐멘테이션의 TIPS를 썼습니다.

물론 가장 중요한 것은 내용입니다만, 조금 궁리하면 독자도 자신도 읽기 쉽게 되어 좋다고 생각합니다. 좋은 Qiita 기사의 증가에 이 기사가 조금이라도 봉사하면 기쁩니다.

변경 내역

2020/08/07 Qiita 기사의 소스를 보는 방법을 Twitter의 코멘트를 바탕으로 수정