-
프로는 문서로 말한다
- 아마추어나 사기꾼은 번지르르한 말뿐이고, 프로는 명쾌한 문서로 말한다
- 보고서 제목은 신문 헤드라인처럼 뽑아라 MECE(Mutually Exclusive, Collectively Exhaustive)
- 프로는 문서로 말한다 ③
-
How I wrote and published my novel using only open source tools
-
- 업무 대화를 할 때(이메일, 메신저 등) 정리, todo등의 중요성을 강조하는 내용
- 모든 업무 대화는 질문, 부탁/지시, 정보 전달 중 한 가지 주제의 이야기여야 한다
-
How to Use the STAR Interview Response Technique 글쓰기가 아니라 interview 기법이지만 글쓰기에 응용 가능
-
Amazon
프레젠테이션 툴 없이 ‘글’로만 회의하는 아마존의 문화. 이 ‘6페이지 문서’는 베조스와 아마존의 실용적인 문화 상징 1. 서문: 이전 사업 대비 차별점과 특장점, 무엇을 얻고 싶은지 밝힙니다. 체계적으로 발전시킬 부분을 찾는 게 포인트 2. 목표: 최소 3개로 정리. 틀에 맞춰서 간결하게 작성. 사업을 완전히 꿰고 있어야 가능 3. 아마존 리더십 원칙 적용: 베조스가 늘 강조하는 ‘아마존의 리더십 원칙 14개’를 해당 사업에 접목 4. 해당 사업 현황 프로젝트를 낱낱이 분석해서 수치로 표현. 비즈니스모델은 무엇인지, 어떤 리스크가 있고 대비책은 무엇인지 숫자로 내러티브를 만들고, 맥락에서 의미를 찾아내야 함 5. 배운 점 돌아보기: 과거 회고. 아마존은 ‘실패가 더 현실적’이라고 봄. 이 섹션의 목적은 실패 원인을 명확히 6. 전략적 우선순위 설정 목표를 달성하기 위해 할 일. ‘예측’과 ‘실행계획’이 중요 이 섹션은 작성자의 ‘생각’이 가미되기 때문에, 회의에서도 피드백과 질문이 쏟아진다고 함 7. 마무리: 한 단락, 5문장 안으로 간결하게 서술. 긍정적이고 미래지향적으로 -
직딩이 글쓰기를 연마해야 하는 이유. 미디엄을 다시 시작하고 나서 한번 다뤄볼까 싶었던 주제가 있다… | by Ghost_0503 | Mar, 2021 | Medium
-
38 Incredible Notetaking Statistics You Should Know | Paperlike
-
신입/주니어에게 글쓰기가 주는 5가지 혜택. 글쓰기는 초기 개발자 커리어에 도움이 된다. 어쩌면 경력 내내… | by 송요창 | Aug, 2022 | Medium
-
<책 나왔니?> 개앞맵시와 신백균의 첫 책으로 가는 길 글쓰기에 대한 직접적인 이야기는 아니고 책 발간에 대한 이야기
-
Canonical Everything. “Where can I find out what I need to… | by Naomi Gleit | Medium
-
문서 쓰는 디자이너. 알라미 팀 디자이너가 문서 작성하는 법 | by DelightRoom | DelightRoom | Aug, 2023 | Medium
-
한 번만 읽어도 책 내용 다 기억하는 기적의 독서 메모 법 | 김익한 @ican 명지대 교수, 기록학자 #메모 #기록 #독서 - YouTube
-
효과적인 릴리즈 노트 작성 방법 | InfoGrab, DevOps 전문 기술 기업 | 인포그랩 | GitLab기반 DevSecOps 구축,컨설팅,교육,기술지원 서비스 제공 release note
-
- 진정성 인사이트 디테일 유용성 참여유도
- latex
- Free & Interactive Online Introduction to LaTeX
- Scripts for Latex to HTML5 conversion
- 온라인으로 쓰는 Latex, 오버리프(Overleaf) : 클리앙
- kiss-latex-mindset - I looked around for some LaTeX framework but definitely that's not what I'd like
- LATEX BOILERPLATES PLAIN-TEXT DOCUMENT PRODUCTION SYSTEM
- "HWP 수식을 LaTeX으로"…오픈소스 변환기 등장
- 라텍스 수식 편집기
- Guppy - A WYSIWYG Mathematics Editor Enter mathematical expressions below (help)
- 8 Best LaTeX Editors
- How I'm able to take notes in mathematics lectures using LaTeX and Vim
- Learn LaTeX online for free in beginner friendly lessons | learnlatex.org
- Web Publications — LaTeX Style
- LaTex Markdown 수식 작성법
- LaTeX.css — Make your website look like a LaTeX document
- mathpix - LaTeX, instantly
- OpenDetex - Improved version of Detex - tool for extracting plain text from TeX and LaTeX sources
- SwiftLaTeX, a WYSIWYG Browser-based LaTeX Editor
- Tectonic Rust로 작성된 TeX 컴파일러, Tectonic
- Typst: Compose papers faster
- 데이터 과학자의 데이터로 책 쓰기: 데이터는 기획력과 감수성이다
- SI 개발 프로세스 (절차 및 산출물 요약)
- (2017) 학술논문작성법
- On Writing Product Specs
- 영어 못해도 논문 잘 읽는 법
- 글쓰는 개발자가 되자
- Tech has a Toxic Tone Problem — Let’s Fix It!
- 동료를 선배, 선생님으로 부르게 된 사연. 기술 업계의 독성 말투 문제, 고칩시다! 글을 읽어보면 장구한 역사를… | by 송요창 | Jul, 2022 | Medium writing과는 직접 관련은 없지만
- What nobody tells you about documentation
- 좋은 기술 블로그를 만들어 나가기 위한 8가지 제언
- 면접관 관점에서 본 좋은 개발자 블로그
- Write The Docs 3월 밋업 발표자료
- 문서 엔지니어링과 API 문서화
- 주석 분석기를 이용한 간단한 API 문서화 방법 - LINE ENGINEERING
- 더 자유롭고, 빠르고, 정확하게: 토스페이먼츠 API 문서 엔지니어링 MDX OAS
- 더 자유롭고, 빠르고, 정확하게: 토스페이먼츠 API 문서 엔지니어링
- Why developers should know how to write
- The most important part of a data science project is writing a blog post
- 잘못 된 문서화, 잘 된 문서화
- 개발문화.. 문서화.. 프로세스 :: GS Retail Engineering
- 실전 Digital Tranformation 아이디어 공유
- 2019년 11월 2일 개발자 이야기(발표 자료) 튜토리얼과 하우투 문서의 차이점
- The documentation system — Documentation system documentation Tutorial how-to-guides explanation reference 차이점
- (개발자 영어 #2) 개발 과정에서 클린한 코드 문서화 방법
- Code Documentation. That ugly thing...
- Most tech content is bullshit 기술 콘텐츠는 대체로 헛소리다
- Top 29 Developer Docs - DEV
- 그것이 알고 싶다 - 왜 개발자는 글을 못 쓸까? - LINE ENGINEERING
- 컴퓨터 프로그래밍에 대한 명언 101가지 | IT의 중심에서
- How to write the introduction for a research paper - Google Slides
- 개발자영어 #1 개발자에게 영어가 중요한 이유 - YouTube
- 개발자영어 #2 개발 과정에서 클린한 코드 문서화 방법 - YouTube
- 개발자영어 #3 영어 정보 찾기와 읽기 - YouTube
- ’19 S/W 정보교육 교원 연수
- 코딩으로 글쓰는 슬기로운 탐구생활
- Why programmers don’t write documentation | Kislay Verma
- Writing as a dominant engineering skill | LinkedIn
- LaTeX 과 PDF
- LaTeX 과 PDF
- The Renaissance of Code Documentation: Introducing Code Walkthrough
- Tech Lab 개발 블로그는 어떻게 써야할까?. 안녕하세요. 좋은 개발자로 성장할 수 있는 환경을 만들고 서포트하는… | by F-Lab | F-Lab | Medium
- What makes library docs great Library review: Iron - DEV Community
- Two open source projects with great documentation • johnjago.com
- apiDoc - Inline Documentation for RESTful web APIs
- API Improvement Proposals
- art-of-readme: Things I've learned about writing good READMEs
- The C4 model for visualising software architecture
- C4Model로 협업하기 | Doublem.org
- C4Model 과 함께일하기 — 1편. 동료 개발자와 협업하기 | by Jaeyeoul Ahn | 월요일 오후 9시 | Medium
- C4Model 과 함께일하기 — 2편. c4모델을 이용한 협업기록 | by Jaeyeoul Ahn | 월요일 오후 9시 | Medium
- 쉽게 설명한 C4Model (Demystifying C4Model), Haandol
- C4 모델과 C4-PlantUML을 이용한 소프트웨어 구조 다이어그램 만들기
- Building a Documentation Culture :: antrix.net
- Devin Horsman – Simple, useful software architecture with C4 - YouTube
- C4 Models as Code • Simon Brown • YOW! 2022 - YouTube
- C4 Models as Code • Simon Brown • YOW! 2022 - YouTube
- Diagrams as code 2.0 • Simon Brown • Devoxx Poland 2022 - YouTube
- Creating Software with Modern Diagramming Techniques • Ashley Peacock & Stefan Hofer - YouTube
- c4viz: c4viz: C4 Visualization
- Structurizr
- Doxygen: Main Page
- GitBook
- hermes: A document management system
- Introducing Hermes, An Open Source Document Management System
- HashiCorp 문서 관리 시스템 Hermes 공개
- Hermes은 Ember.js와 Golang으로 작성, PostgreSQL과 Algolia 사용
- Google Workspace를 지원하기 때문에 문서 작성을 Google Workspace에서 가능
- Introducing Hermes, An Open Source Document Management System
- ko-translation-terms: 더 나은 번역을 위한 프로그래밍 용어 번역 용례집입니다
- Mintlify | Continuous Documentation Platform
- Quarto open-source scientific and technical publishing system built on Pandoc
- Tom Mock - Reproducible Publications with Python and Quarto | PyData Global 2022 - YouTube
- Create beautiful documents with Quarto and R - YouTube
- "파이썬, 비주얼 스튜디오 사용자 품는다” 차세대 R 마크다운, 콰르토 - ITWorld Korea
- 코딩으로 문서 작성하는 콰르토(Quarto) 톺아보기 | 요즘IT
- quarto, webR, github page로 서버리스 shiny application 만들기 · Present
- Quarto - Quarto Dashboards
- redoc - OpenAPI/Swagger-generated API Reference Documentation https://redocly.github.io/redoc
- 모두가 행복해지는 API 문서 통합과 자동화
- Line에서 OpenAPI로 API 문서를 관리하고 있지만 문서가 많아지면서 찾아보기 어려운 문제가 생김에 따라 이를 통합 관리한 과정
- springdoc-openapi-gradle-plugin을 사용해서 API 문서의 JSON 파일을 만들게 하고
- 문서를 소비하는 독자에 맞게 그루핑해서 프론트엔드, 인터널, 어드민 등으로 나누어서 문서를 모아서 볼 수 있게 작성
- JSON 파일을 HTML로 변환해서 GitHub Actions로 자동화해서 GitHub Pages에서 제공
- 모두가 행복해지는 API 문서 통합과 자동화
- slate Doing Stupid Stuff with GitHub Actions | DevOps Directive
- standardese: A (work-in-progress) nextgen Doxygen for C++
- Swimm Knowledge management and documentation for code | Swimm
- ‘문서’로 세상에 도움을 주는 테크니컬 라이터, 강정일
- 테크니컬 라이팅 컨퍼런스: API the Docs Chicago 2019 방문기
- Publish Technical Tutorials in Google Codelab Format
- Notes on Technical Writing
- The Mayfield Handbook of Technical & Scientific Writing
- Writing a technical book: from idea to print
- 구글 테크니컬라이터가 전하는 이야기 - Tech. Writer Log
- “좋은 문서 없으면 좋은 코드도 없어” 테크니컬 라이터의 중요성 - ITWorld Korea
- '테크니컬라이팅' 태그의 글 목록
- 테크니컬 라이팅 4대 원칙
- 토스의 8가지 라이팅 원칙들
- 퇴고의 기술 #기술문서_작성법#개발자_글쓰기 #테크니컬라이터
- 글을 쓰고 다시 살펴보며 수정하는 퇴고는 글쓰기에서 중요하지만, 사람은 아는 내용의 경우 눈을 100% 사용하지 않기 때문에 효과적으로 하기가 어려우므로 몇 가지 팁 제공
- 내 글을 낯설게 하기 위해 소리 내 읽거나 일정 시간 뒤에 읽거나 종이로 프린트해서 읽어 볼 수 있다
- 다른 사람이 읽고 피드백을 줄 수 있는 피어리뷰를 도입하는 것은 아주 효과적이다.
- 퇴고에서 공통으로 확인해야 항목은 체크리스트로 만들어서 관리하는 것이 좋다.
- 퇴고 시에는 문장은 단문으로 정리하고 불필요한 표현을 제거하고 대명사 대신 직접 대상을 언급하면서 논리적으로 구성하는 게 좋다.
- 글을 쓰고 다시 살펴보며 수정하는 퇴고는 글쓰기에서 중요하지만, 사람은 아는 내용의 경우 눈을 100% 사용하지 않기 때문에 효과적으로 하기가 어려우므로 몇 가지 팁 제공
- Troubleshooting 가이드 톺아보기 #기술문서 #테크니컬라이팅 #테크니컬라이터
- 내가 오래된 컴퓨터 매뉴얼을 모으고 읽는 이유 | GeekNews
- About this guide | Google developer documentation style guide | Google Developers
- Tools for a Culture of Writing
- 사내 용어 사전, LINE Words 오픈 여정기 - LINE ENGINEERING
- We rebuilt Cloudflare's developer documentation - here's what we learned
- Writing for Engineers
- 엔지니어를 위한 글쓰기
- 글을 쓸 때 글감이나 태도에 대해 다루고 글을 쓰기 전에 좋은 글을 쓰기 위해 줄거리나 요약 등을 적는 방법, 글쓰기를 연습하는 방법 소개
머리에 명확한 메시지가 아직 없다면, 당신은 아직 글 쓸 준비가 되지 않은 것입니다.글쓰기 기술을 향상하는 유일한 방법은, 바로 글을 써보는 것입니다. 대부분의 많은 연습이 그렇듯이, 질보다 양을 중시하는 건 보통 좋은 생각입니다.
- 엔지니어를 위한 글쓰기
- 아마존에서 배운 5가지 글쓰기와 소통 방식 :: Channy's Blog
- 데이터를 기반으로 명확하게
- 이 문장을 이용해서 이유, 결과, 배운 점, 다음 단계 등으로 구조화된 문장 구성
- 회의 때는 미리 작성한 문서를 다 같이 읽어서 정보 일치
- "잘한 점", "못한 점", "배운 점", "문제점"을 꼭 모두 작성
- 소통할 때는 항상 예의를 차려서 정중하게
- 개발자에서 기술 작가로 전직하기까지 2년 간의 이야기
- 15년 넘게 엔지니어로 일하다가 기술 작가(테크니컬 라이터)로 전직한 경험 정리
- 기술 작가는 "복잡한 정보를 독자의 눈높이에 맞추어 다양한 형태의 매체로 알기 쉽게 풀어서 설명해주는 일을 하는 사람"
- 문서화가 중요하다고 하면서도 실제로 개선이 되지 않는 상황이 안타까워서 직접 기술 작가로 전직
- 기술 작가의 일이 꼭 글일 필요는 없으므로 사내 세미나를 녹화해서 공유하고 사내 소식지를 발행하거나 문서화를 위한 도구도 개발
- 개발자에서 기술 작가로 전직하기까지 2년 간의 이야기 | GeekNews
- 기술 글쓰기를 통해 개인 브랜딩을 구축하는 나만의 방법 - 재그지그의 개발 블로그
- Overview of technical writing courses | Technical Writing | Google Developers
- Leadership Principles for AWS News Bloggers
- 쏘카에서 기술 블로그를 운영하는 방법 - SOCAR Tech Blog
- 자주 틀리는 띄어쓰기, 여기서 딱 정해 드립니다 : NHN Cloud Meetup
- 테크니컬 라이터와 Git
- 넷마블 테크니컬 라이터로 일한 8개월의 회고 - 넷마블 기술 블로그
- Engineering Documentation • Lorna Jane Mitchell • GOTO 2022 - YouTube
- 테크니컬 라이팅 강연에서 나왔던 질문과 답변 모음 | make -k it (메이킷)
- Blog Writing for Developers
- 그 많은 개발 문서는 누가 다 만들었을까 (1) 토스페이먼츠 테크니컬 라이터가 하는 일
- 그 많은 개발 문서는 누가 다 만들었을까 (2) 개발자의 학습을 돕는 모든 것
- How (not) to apply for a software job
- practice - 기술 작가와 함께 알아가는 테크니컬 라이팅 - 비문학 정보전달 글쓰기의 기본
- 보이지 않는 로직, 읽을 수 있는 문서로 만들기! 정책서 policy
- 문서 작성 및 관리 노하우를 알리는 행사, Technical Documentation Day 참석 후기
- TCN - Technical Communicator Network : 네이버 카페
- WriteTheDocsSeoul | Facebook