-
프로는 문서로 말한다
- 아마추어나 사기꾼은 번지르르한 말뿐이고, 프로는 명쾌한 문서로 말한다
- 보고서 제목은 신문 헤드라인처럼 뽑아라 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
- 데이터 과학자의 데이터로 책 쓰기: 데이터는 기획력과 감수성이다
- SI 개발 프로세스 (절차 및 산출물 요약)
- 학술논문작성법
- (2017) 학술논문작성법
- On Writing Product Specs
- 영어 못해도 논문 잘 읽는 법
- 글쓰는 개발자가 되자
- Tech has a Toxic Tone Problem — Let’s Fix It!
- What nobody tells you about documentation
- 좋은 기술 블로그를 만들어 나가기 위한 8가지 제언
- Write The Docs 3월 밋업 발표자료
- 문서 엔지니어링과 API 문서화
- 주석 분석기를 이용한 간단한 API 문서화 방법 - LINE ENGINEERING
- 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
- Building a Documentation Culture :: antrix.net c4model
- The Renaissance of Code Documentation: Introducing Code Walkthrough
- apiDoc - Inline Documentation for RESTful web APIs
- API Improvement Proposals
- The C4 model for visualising software architecture
- Doxygen: Main Page
- GitBook
- redoc - OpenAPI/Swagger-generated API Reference Documentation https://redocly.github.io/redoc
- slate Doing Stupid Stuff with GitHub Actions | DevOps Directive
- standardese: A (work-in-progress) nextgen Doxygen for C++
- ‘문서’로 세상에 도움을 주는 테크니컬 라이터, 강정일
- 테크니컬 라이팅 컨퍼런스: 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대 원칙
- 퇴고의 기술 #기술문서_작성법#개발자_글쓰기 #테크니컬라이터
- 글을 쓰고 다시 살펴보며 수정하는 퇴고는 글쓰기에서 중요하지만, 사람은 아는 내용의 경우 눈을 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
- 엔지니어를 위한 글쓰기
- 글을 쓸 때 글감이나 태도에 대해 다루고 글을 쓰기 전에 좋은 글을 쓰기 위해 줄거리나 요약 등을 적는 방법, 글쓰기를 연습하는 방법 소개
머리에 명확한 메시지가 아직 없다면, 당신은 아직 글 쓸 준비가 되지 않은 것입니다.
글쓰기 기술을 향상하는 유일한 방법은, 바로 글을 써보는 것입니다. 대부분의 많은 연습이 그렇듯이, 질보다 양을 중시하는 건 보통 좋은 생각입니다.
- 엔지니어를 위한 글쓰기