technical writing resources

概要

• 概要
• リソース
• テクニカルライティングとは何ですか？
• 記事
• 本
• コース
• YouTube
• コミュニティ
• 書き込みツール
• ドキュメントツール
• 技術作家を支払う人
• オープンソースプロジェクト
  • オープンソースプロジェクト/プログラムテクニカルライターは貢献できます
• 素晴らしい執筆コンテンツをフォローするブログ
• テクニカルライティングインタビューの準備
• 記事を公開するサイト
• テクニカルライティングの役割のための求人

リソース

このリポジトリには、インターネット全体から収集されたさまざまなテクニカルライティングリソースが含まれています

テクニカルライティングとは何ですか？

テクニカルライティングは、ユーザーがテクノロジーの問題を解決するのに役立つコミュニケーションの一形態です。これは、意図した視聴者が簡単に理解できる方法で複雑な情報を伝えるように設計された明確で簡潔で有益なコンテンツを作成するプロセスです。

多くの場合、技術的な概念、プロセス、または製品を説明するマニュアル、ガイド、レポート、ドキュメントを作成することが含まれます。

記事

• ブログポストを超えたテクニカルライティング
• テクニカルライティングを始める方法
• テクニカルライターになる方法
• 初心者向けのテクニカルライティング - ハイテクブログの基本のAZガイド
• テクニカルライティング：何とどのように？
• テクニカルライティングを無料で学ぶ方法
• テクニカルライティングを開始します
• テクニカルライティングのアドバイス
• 読者がユーザー心理学からの学習に基づいて読むコンテンツを書く方法
• テクニカルライティングポートフォリオの作成方法
• ソフトウェア開発者向けのヒントを書く - より良いハイテクライターになる方法
• APIドキュメントを作成するための11のベストプラクティス
• テクニカルライティングとテクニカルブログ

本

• よく書く〜Julian Shapiro

• テクニカルライティング、簡素化〜ネルジョンソン

• Sotware Developers 〜Philip Kielyのために執筆

• ダミー〜シェリルリンゼルロバーツのテクニカルライティング

• 開発者向けのドキュメント：テクニカルライティングのエンジニアのフィールドガイド〜JaredBhatti

• 現代のテクニカルライティング：ソフトウェアドキュメントの紹介〜Andrew Etter

• 誰もが書いている：途方もなく良いコンテンツを作成するためのあなたの頼りになるガイド〜アン・ハンドリー

• よく書くことで〜ウィリアム・ジンザー

• テクニカルコミュニケーション〜マイクマルケル

コース

• エンジニア向けのテクニカルライティングコース
• テクニカルライティング：ソフトウェアドキュメントの作成方法
• APIテクニカルライティングを学ぶ：JSONとXML for Writers
• APIドキュメントの芸術
• APIの文書化：技術作家とエンジニアのためのガイド
• テクニカルライター認定コース〜テクニカルライター認定コースは、テクニカルライターまたはテクニカルライティングスキルを磨きたい人向けに作成されました。
• SEO for devs〜seo for devsは、人々があなたの技術ブログや体系的な方法で発見するのに役立つ無料の2週間のコースです
• 開発者向けのAPIドキュメント〜APIドキュメントを作成および維持するための実践ガイド。

YouTube

• Doctohelptv
• テクニカルライターHQ
• アムルタ・ラネード
• ウィリアム・スミス
• テクニカルライターになる方法|スキルとキャリアの成長

コミュニティ

コミュニティは、貴重な学習の機会、成長、指導、キャリアの進歩を提供することができます。同様の関心のある人々とつながることは、人々がコミュニティに参加する理由の1つです。技術作家が参加できるコミュニティの一部は次のとおりです。

• ドキュメントを書きます
• docnext
• ハックマンバ
• LinkedInテクニカルライティングコミュニティ
• グローバルライターコミュニティ
• APIドキュメントグループ
• テクニカルライターフォーラム
• ハスノード
• Good Docsプロジェクトコミュニティ
• TechWriters.dev
• R/テクニカルライティング

書き込みツール

• Canva〜Canvaは、ソーシャルメディアのグラフィック、プレゼンテーション、ポスター、ドキュメント、その他の視覚コンテンツを作成するために使用されるグラフィックデザインプラットフォームです。
• removebg〜画像の背景を削除するために使用されるツール。
• Markdown〜Markdownは、Webライター向けのテキストツーHTML変換ツールです。
• Asciidoc〜asciidocは、主に技術文書を作成するために設計された軽量でセマンティックマークアップ言語です。
• デニグマ〜デニグマは、理解できる英語でコードを説明するツールです。
• Grammarly〜Grammarlyは、スペル、文法、句読点、明確さ、エンゲージメント、配信の間違いをレビューするタイピングアシスタントです。
• Hemingway App〜Hemingwayアプリは、ライティングスタイルを改善してコンテンツを修正できるWebおよびデスクトップアプリです。
• Quillbot ai〜quillbot aiは、執筆スタイルの改善に役立つ多目的ライティングツールです。その製品のいくつかは、パラフラザー、文法チェッカー、盗作チェッカー、共同作家、サマリザー、引用ジェネレーター、ワードカウンターです。
• 概念〜概念は、メモ、タスク、ウィキ、およびデータベースのオールインワンワークスペースです。これは、思考、プロジェクト、情報を整理するために使用できるツールです。
• Dropbox Paper〜Dropbox Paperは、オンラインドキュメントワークスペースで、テキスト、メディア、ファイルをすべて1か所で整理および表示できます。
• GofullPage-フルページ画面キャプチャ〜Chrome拡張機能TAHTを使用すると、現在のブラウザウィンドウのページフル画面を取得できます。
• カーボン〜カーボンは、ソースコードの美しい画像を作成して共有する最も簡単な方法です。
• ISITWP〜ISITWPヘッドラインアナライザーツールは、検索結果でトラフィックを促進し、共有し、ランク付けするヘッドラインを作成するのに役立ちます。
• 私のタイトルを大文字に〜タイトルの大文字化を簡単に作成する
• WordTune〜WordTuneは、テキストを簡潔で魅力的な、よく書かれたメッセージに変えます。
• ヘッドラインアナライザー〜トラフィック、シェア、および検索結果を駆動するヘッドラインを書きます。
• タイトルジェネレーター〜記事やブログ投稿に最適なタイトルを生成します。
• SEOライティングアシスタント〜エンゲージメントとSEOのためにコピーを最適化するのに役立つスマートライティングエディター。
• hackmd〜あなたの記事を共有し、他の人からフィードバックを得るための共同マークダウンエディター。
• Copyscape〜Plagiarism Checker
• Markdoc〜カスタムドキュメントWebサイトを作成するためのMarkdownのスーパーセット。 Stripeによって作成され、2022年5月にオープンソースが作成されました。
• WordTune〜WordTuneは、あなたの文章を言い換えて、明確で説得力のある、本物の文章を通してあなたが意味することを正確に言うように言います。

ドキュメントツール

• gitbook〜チームが製品から内部知識ベースやAPIに至るまですべてを文書化できる最新のドキュメントプラットフォーム。
• ドキュメント〜ホスティング、構築、バージョンのドキュメントのためのオープンソースプラットフォームをお読みください。
• docusaurus〜オープンソースプロジェクトWebサイトを簡単に構築できる静的サイトジェネレーター。
• Sphinx〜rsmulturturedTextファイルをHTML Webサイトおよびその他の形式に変換するドキュメントジェネレーター。
• mkdocs〜プロジェクトのドキュメントの構築に向けた高速でシンプルで静的なサイトジェネレーター。
• Swagger〜Swagger Editor、Swagger UI、Swagger Codegenなど、APIドキュメント用のツールスイート。
• Postman〜API開発のためのコラボレーションプラットフォームにより、APIを簡単に作成、共有、テスト、および文書化できます。
• Slate〜APIドキュメント用に特別に設計された静的サイトジェネレーター。
• Redoc〜Openapi（以前のSwagger）定義からAPIドキュメントを生成するためのオープンソースツール。
• docz〜MDXとライブRELOADサポートを使用したReactコンポーネントのドキュメントを作成するためのツール。
• Jekyll〜平易なテキストを静的なWebサイトやブログに変換する静的サイトジェネレーター。
• Hugo〜GOで書かれた高速で柔軟な静的サイトジェネレーター。
• Antora〜ドキュメントポータルと技術ドキュメントWebサイトを作成するためのドキュメントサイトジェネレーター。
• vuepress〜vue.jsを搭載した静的サイトジェネレーター
• ASCIIDOCTOR〜ASCIIDOCコンテンツをHTML5、DocBook、PDF、およびその他の形式に変換するための高速テキストプロセッサと公開ツールチェーン。
• Confluence〜チームがコラボレーションと知識を効率的に共有するのを支援するために使用されるコラボレーションツール。
• MADCAP FLARE〜さまざまな出力用のコンテンツを作成するための包括的な技術オーサリングおよび公開ツール。

技術作家を支払う人

組織や出版物のために技術的なコンテンツを書くことは、余分な収入を得るための優れた方法です。このようにして、あなたは多くを学び、それからあなたの知識を共有して報酬を得ます。技術作家を支払う組織のこれらのコンパイルされたリストをご覧ください。

• コミュニティライタープログラム
• これらの45以上のWebサイトの書くために報酬を受け取ります
• 技術記事を書くためにあなたに支払う出版物

オープンソースプロジェクト

オープンソースに貢献することは、想像できるあらゆるスキルで経験を学び、教え、構築するためのやりがいのある方法です。多くのPeoleが、さまざまな理由でオープンソースに貢献し、スキルセットを改善している重要なものです。

オープンソースプロジェクトに貢献する方法を理解するのに役立つ記事をいくつか紹介します。

• 技術作家のためのオープンソース
• オープンソースプロジェクトに貢献するためのテクニカルライターガイド
• テクニカルライターとしてのオープンソースに貢献する方法
• オープンソースの貢献をしているテクニカルライターになるための4つのヒント
• テクニカルライターとしてのオープンソースを始めましょう

オープンソースプロジェクト/プログラムテクニカルライターは貢献できます

• Codecademy docs〜docsは、一般的なプログラミング言語とフレームワーク向けのコードドキュメントのコミュニティ主導のコレクションです。
• Good Docs Project〜Good Docs Projectは、OSSおよびそれ以降のドキュメントの全体的な品質を向上させるためのテンプレート、ツール、リソースを作成するために協力して協力するコミュニティです。
• Google Season of Docs〜Docsのシーズンは、ドキュメントを改善するためのオープンソースプロジェクトのサポートを提供し、専門的な技術ライターにオープンソースでの経験を積む機会を提供します。
• Hacktoberfest〜Hacktoberfestは、10月に人々がオープンソースに貢献することを奨励する毎年のイベントです。
• GNOMEドキュメントプロジェクト

素晴らしい執筆コンテンツをフォローするブログ

• TechWriters Hub
• ケシパーカー
• iDratherbewriting
• すべてのテクニカルライティング
• WriteTech Hub
• ハックマンバ

テクニカルライティングインタビューの準備

インタビューを行うのに役立ついくつかのヒントがありますが、いくつかの重要なものには、適切に仕立てられた履歴書とカバーレターがあります。これらのカバーレターのテンプレートとヒントをチェックして、次のインタビューを上陸させるのに役立ちます。

• 次の仕事のカバーレターテンプレート
• 魅力的なカバーレターの書き方
• テクニカルライターの履歴書の書き方[+例]
• 最高のテクニカルライターのカバーレターの例と形式

次のインタビューの準備を支援するために、テクニカルライティングインタビューの質問にいくつかのリソースを紹介します。

• 12テクニカルライターインタビューの質問と回答
• Googleテクニカルライターインタビューの質問
• テクニカルライティングの就職面接

記事を公開するサイト

• Hashnode〜Hashnodeは、テクノロジー、開発者、エンジニアの人々とアイデアを共有するのに役立つ無料の開発者ブログプラットフォームです。
• Medium〜mediumは、多くのユーザーを抱えるソーシャルパブリッシングプラットフォームであり、多様なコンテンツやアイデアを公開できます。
• dev.to〜dev.oは、プログラマーがアイデアを共有し、お互いを成長させるのを助けます。素晴らしいアイデアを共有して発見するためのオンラインコミュニティです。
• Mirror.xyz〜Mirror.xyzは、暗号通貨とブロックチェーンテクノロジーを活用する作家向けの出版プラットフォームです。
• FreeCodecamp〜FreeCodecampは、インタラクティブな学習Webプラットフォーム、オンラインコミュニティフォーラム、チャットルーム、オンライン出版物、学習Web開発を誰でもアクセスできるようにするつもりである非営利組織です。

テクニカルライティングの役割のための求人

• テクニカルライターのトップジョブボード

• startup.jobs

• よく発見されました

• 最高のライティングジョブ

Damilola Ezekielが❤§で作られています