technical writing resources

개요

• 개요
• 자원
• 기술 작문이란 무엇입니까?
• 조항
• 서적
• 행동
• YouTube
• 커뮤니티
• 쓰기 도구
• 문서 도구
• 기술 작가를 지불하는 사람
• 오픈 소스 프로젝트
  • 오픈 소스 프로젝트/프로그램 기술 작가가 기여할 수 있습니다
• 멋진 글쓰기 내용을 위해 따라야 할 블로그
• 기술 작문 인터뷰 준비
• 기사를 게시 할 사이트
• 기술 작문 역할을위한 구인 보드

자원

이 저장소에는 인터넷 전역에서 수집 된 다양한 기술 작문 리소스가 포함되어 있습니다.

기술 작문이란 무엇입니까?

기술 작문은 사용자가 기술 문제를 해결하는 데 도움이되는 커뮤니케이션의 한 형태입니다. 그것은 의도 된 청중이 쉽게 이해할 수있는 방식으로 복잡한 정보를 전달하도록 설계된 명확하고 간결하며 유익한 컨텐츠를 만드는 과정입니다.

기술 개념, 프로세스 또는 제품을 설명하는 매뉴얼, 안내서, 보고서 및 문서 작성이 포함됩니다.

조항

• 블로그 포스트를 넘어 기술 쓰기
• 기술 작문을 시작하는 방법
• 기술 작가가되는 방법
• 초보자를위한 기술 작문 - 기술 블로깅 기본 사항을위한 AZ 가이드
• 기술 작문 : 뭐, 어떻게?
• 무료로 기술 작문을 배우는 방법
• 기술 작문을 시작하는 것
• 기술 작문에 대한 조언
• 사용자 심리학의 학습에 따라 독자가 읽을 콘텐츠를 작성하는 방법
• 기술 작문 포트폴리오를 만드는 방법
• 소프트웨어 개발자를위한 팁 작성 - 더 나은 기술 작가가되는 방법
• API 문서 작성을위한 11 가지 모범 사례
• 기술 작문 대 기술 블로깅

서적

• 잘 쓰기 ~ 줄리안 샤피로

• 기술 작문, 단순화 ~ Nell Johnson

• Sotware 개발자를위한 글쓰기 ~ Philip Kiely

• Dummies를위한 기술 작문 ~ Sheryl Lindsell-Roberts

• 개발자를위한 문서 : 기술 작문을위한 엔지니어의 현장 안내서 ~ Jared Bhatti

• 현대 기술 저술 : 소프트웨어 문서 소개 ~ Andrew Etter

• 모두가 글을 씁니다 : 엄청나게 좋은 콘텐츠를 만들기위한 가이드 ~ Ann Handley

• 글을 잘 쓰 ~ 윌리엄 Zinsser

• 기술 커뮤니케이션 ~ Mike Markel

행동

• 엔지니어를위한 기술 작문 과정
• 기술 쓰기 : 소프트웨어 문서 작성 방법
• 작가를위한 API 기술 작문 : JSON 및 XML을 배우십시오
• API 문서의 기술
• API 문서화 : 기술 작가 및 엔지니어를위한 안내서
• 기술 작가 인증 과정 ~ 기술 작가 인증 과정은 주목받는 기술 작가 또는 기술 작문 기술을 닦고 싶어하는 사람들을 위해 만들어졌습니다.
• Devs for Devs ~ SEO 용 SEO는 사람들이 기술 블로그 나 부수적 프로젝트를 체계적으로 발견하는 데 도움이되는 무료 2 주 과정입니다.
• 개발자를위한 API 문서 ~ API 문서 작성 및 유지 관리에 대한 실습 가이드.

YouTube

• doctoHelptv
• 기술 작가 본사
• Amruta Ranade
• 윌리엄 스미스
• 기술 작가가되는 방법 | 기술 및 경력 성장

커뮤니티

지역 사회는 귀중한 학습 기회, 성장, 멘토링 및 경력 발전을 제공 할 수 있습니다. 비슷한 관심을 가진 사람들과 연결하는 것은 사람들이 지역 사회에 가입하는 이유 중 하나입니다. 기술 작가가 참여할 수있는 커뮤니티 중 일부는 다음과 같습니다.

• 문서를 작성하십시오
• docnext
• Hackmamba
• 링크드 인 기술 작문 커뮤니티
• 글로벌 작가 커뮤니티
• API 문서 그룹
• 기술 작가 포럼
• Hashhnode
• 좋은 문서 프로젝트 커뮤니티
• TechWriters.dev
• r/기술 작곡

쓰기 도구

• Canva ~ Canva는 소셜 미디어 그래픽, 프레젠테이션, 포스터, 문서 및 기타 시각적 컨텐츠를 만드는 데 사용되는 그래픽 디자인 플랫폼입니다.
• removebg ~ 이미지 배경을 제거하는 데 사용되는 도구.
• Markdown ~ Markdown은 웹 작성자를위한 텍스트 간 변환 도구입니다.
• Asciidoc ~ Asciidoc는 주로 기술 문서를 작성하도록 설계된 가볍고 의미 론적 인 마크 업 언어입니다.
• Denigma ~ Denigma는 이해할 수있는 영어로 코드를 설명하는 도구입니다.
• 문법 ~ 문법은 철자, 문법, 구두점, 명확성, 참여 및 전달 실수를 검토하는 타이핑 어시스턴트입니다.
• Hemingway App ~ Hemingway App은 글쓰기 스타일을 향상시키고 콘텐츠를 만질 수있는 웹 및 데스크탑 앱입니다.
• Quillbot ai ~ Quillbot ai는 작문 스타일을 개선하는 데 도움이되는 다목적 작문 도구입니다. 자사의 일부 제품은 Paraphraser, 문법 검사기, 표절 검사기, 공동 저술가, 요약자, 인용 생성기 및 Word 카운터입니다.
• 개념 ~ 개념은 메모, 작업, 위키 및 데이터베이스를위한 올인원 작업 공간입니다. 생각, 프로젝트 및 정보를 구성하는 데 사용할 수있는 도구입니다.
• Dropbox Paper ~ Dropbox Paper는 온라인 문서 작업 공간으로, 한 곳에서 텍스트, 미디어 및 파일을 구성하고 표시 할 수 있습니다.
• GofullPage- 전체 페이지 화면 캡처 ~ Chrome Extension Taht를 사용하면 현재 브라우저 창의 전체 페이지 스크린 샷을 찍을 수 있습니다.
• Carbon ~ Carbon은 소스 코드의 아름다운 이미지를 생성하고 공유하는 가장 쉬운 방법입니다.
• ISITWP ~ ISITWP 헤드 라인 분석기 도구를 사용하면 검색 결과에서 트래픽을 유도하고 공유 및 순위를 높이는 헤드 라인을 작성하는 데 도움이됩니다.
• 내 제목 대문자 ~ 제목 대문자 만들기 쉬운 글쓰기
• WordTune ~ WordTune은 텍스트를 간결하고 매력적이며 잘 작성된 메시지로 바꿉니다.
• 헤드 라인 분석기 ~ 트래픽, 공유 및 검색 결과를 유도하는 헤드 라인을 작성하십시오.
• Title Generator ~ 기사 및 블로그 게시물에 대한 훌륭한 타이틀을 생성합니다.
• SEO Writing Assistant ~ 참여 및 SEO를 위해 사본을 최적화하는 데 도움이되는 스마트 작문 편집기.
• Hackmd ~ 기사를 공유하고 다른 사람들로부터 피드백을받는 공동 작업장 편집자.
• Copyscape ~ 표절 검사기
• Markdoc ~ 사용자 정의 문서 웹 사이트를 만들기위한 Markdown의 슈퍼 세트. 그것은 Stripe에 의해 만들어졌으며 2022 년 5 월에 오픈 소스를 만들었습니다.
• WordTune ~ WordTune은 명확하고 매력적이며 진정한 글을 통해 당신이 의미하는 바를 정확하게 말하기 위해 문장을 다시 말하는 AI-Powered Writing Companion입니다.

문서 도구

• Gitbook ~ 팀이 제품에서 내부 지식 기반 및 API에 이르기까지 모든 것을 문서화 할 수있는 최신 문서 플랫폼.
• 문서를 읽으십시오 ~ 문서 호스팅, 빌딩 및 버전 작성을위한 오픈 소스 플랫폼을 읽으십시오.
• Docusaurus ~ 오픈 소스 프로젝트 웹 사이트를 쉽게 구축 할 수있는 정적 사이트 생성기.
• SPHINX ~ 재구성 된 텍스트 파일을 HTML 웹 사이트 및 기타 형식으로 변환하는 문서 생성기.
• mkdocs ~ 프로젝트 문서 구축을위한 빠르고 간단하며 정적 사이트 생성기.
• Swagger ~ Swagger 편집기, Swagger UI 및 Swagger Codegen을 포함한 API 문서 도구 제품군.
• Postman ~ API를 쉽게 작성, 공유, 테스트 및 문서화 할 수있는 API 개발을위한 협업 플랫폼.
• 슬레이트 ~ API 문서를 위해 특별히 설계된 정적 사이트 생성기.
• Redoc ~ OpenApi (이전의 Swagger) 정의에서 API 문서를 생성하기위한 오픈 소스 도구.
• Docz ~ MDX 및 라이브 롤로드 지원을 사용하여 React 구성 요소에 대한 문서를 작성하는 도구.
• Jekyll ~ 일반 텍스트를 정적 웹 사이트 및 블로그로 변환하는 정적 사이트 생성기.
• Hugo ~ 빠르고 유연한 정적 사이트 생성기가 작성되었습니다.
• Antora ~ 문서화 사이트 생성기 문서 포털 및 기술 문서 웹 사이트를 작성하기위한 문서 사이트 생성기.
• vuepress ~ vue.js에 의해 구동되는 정적 사이트 생성기
• ASCIIDOCTOR ~ ASCIIDOC 컨텐츠를 HTML5, DocBook, PDF 및 기타 형식으로 변환하기위한 빠른 텍스트 프로세서 및 게시 툴체인.
• Confluence ~ 팀이 지식을 효율적으로 공유하고 공유하는 데 사용되는 협업 도구.
• MadCap Flare ~ 다양한 출력을위한 컨텐츠 작성을위한 포괄적 인 기술 저자 및 게시 도구.

기술 작가를 지불하는 사람

조직 및 출판물에 기술 내용을 작성하는 것은 추가 수입을 얻는 훌륭한 방법입니다. 이렇게하면 많은 것을 배우고 지식을 공유하고 돈을받습니다. 기술 작가를 지불하는 조직 의이 컴파일 된 목록을 확인하십시오.

• 커뮤니티 작가 프로그램
• 이 45 개 이상의 웹 사이트에 대한 글을 쓰십시오
• 기술 기사를 작성하기 위해 지불하는 출판물

오픈 소스 프로젝트

오픈 소스에 기여하는 것은 상상할 수있는 거의 모든 기술로 경험을 배우고 가르치고 구축하는 보람있는 방법이 될 수 있습니다. 많은 사람들이 다른 이유로 오픈 소스에 기여하고 기술을 향상시키는 중요한 것입니다.

오픈 소스 프로젝트에 기여하는 방법을 이해하는 데 도움이되는 몇 가지 기사가 있습니다.

• 기술 작가를위한 오픈 소스
• 오픈 소스 프로젝트에 기여하기위한 기술 작가 안내서
• 기술 작가로서 오픈 소스에 기여하는 방법
• 오픈 소스 기부금을 가진 기술 작가가되는 4 가지 팁
• 기술 작가로서 오픈 소스를 시작하는 것

오픈 소스 프로젝트/프로그램 기술 작가가 기여할 수 있습니다

• Codecademy Docs ~ Docs는 인기있는 프로그래밍 언어 및 프레임 워크를위한 커뮤니티 중심의 코드 문서 모음입니다.
• Good Docs Project ~ The Good Docs Project는 OSS와 그 이후의 전반적인 문서의 품질을 향상시키기 위해 템플릿, 도구 및 리소스를 만들기 위해 함께 일하는 커뮤니티입니다.
• Docs의 Google 시즌 ~ Docs의 Season of Docs는 문서를 개선하기 위해 오픈 소스 프로젝트를 지원하고 전문 기술 작가에게 오픈 소스에 대한 경험을 얻을 수있는 기회를 제공합니다.
• Hacktoberfest ~ Hacktoberfest는 10 월에 사람들이 오픈 소스에 기여하도록 장려하는 매년 행사입니다.
• 그놈 문서 프로젝트

멋진 글쓰기 내용을 위해 따라야 할 블로그

• Techwriters Hub
• 케시 파커
• Idratherbewriting
• 모든 기술 작문
• WriteTech 허브
• Hackmamba

기술 작문 인터뷰 준비

인터뷰를하는 데 도움이되는 몇 가지 팁이 있지만 중요한 것은 잘 맞춤화 된 이력서와 표지를 가지고 있습니다. 다음 인터뷰에 착륙하는 데 도움이되는이 커버 레터 템플릿 및 팁을 확인하십시오.

• 다음 직업에 대한 표지 템플릿
• 매혹적인 표지를 작성하는 방법
• 기술 작가 이력서를 작성하는 방법 [+예제]
• 최고의 기술 작가 커버 레터 예제 및 형식

다음 인터뷰를 준비하는 데 도움이되는 기술 작문 인터뷰 질문에 대한 몇 가지 리소스가 있습니다.

• 12 기술 작가 인터뷰 질문과 답변
• Google 기술 작가 인터뷰 질문
• 기술 작문 면접

기사를 게시 할 사이트

• Hashhnode ~ Hashnode는 기술, 개발자 및 엔지니어의 사람들과 아이디어를 공유하는 데 도움이되는 무료 개발자 블로깅 플랫폼입니다.
• Medium ~ Medium은 많은 사용자가있는 소셜 출판 플랫폼이며 다양한 내용과 아이디어를 게시 할 수 있습니다.
• Dev.to ~ dev.to는 프로그래머가 아이디어를 공유하고 서로 성장하는 데 도움이됩니다. 훌륭한 아이디어를 공유하고 발견하기위한 온라인 커뮤니티입니다.
• mirror.xyz ~ mirror.xyz는 암호 화폐 및 블록 체인 기술을 활용하는 작가를위한 출판 플랫폼입니다.
• Freecodecamp ~ freecodecamp는 대화식 학습 웹 플랫폼, 온라인 커뮤니티 포럼, 채팅방, 온라인 출판물 및 학습 웹 개발에 액세스 할 수 있도록하는 지역 조직으로 구성된 비영리 조직입니다.

기술 작문 역할을위한 구인 보드

• 기술 작가를위한 최고의 작업 보드

• startup.jobs

• 근절

• 최고의 글쓰기 직업

Damilola Ezekiel의 ❤️으로 제작되었습니다