テクニカルライティングの基本 2023年版テクニカルライティングの基本を学べます。業務マニュアル、報告書、仕様書、技術解説書などのドキュメントを書く機会がある方向け。 サイボウズの2023年度 新入社員向け研修の資料です。 Twitter：https://twitter.com/naoh_nak 2022年版（初版）：https://speakerdeck.com/naohiro_nakata/technicalwriting
Technical Writing | Google for Developers
Send feedback Stay organized with collections Save and categorize content based on your preferences. Every engineer is also a writer. This collection of courses and learning resources aims to improve your technical documentation. Learn how to plan and author technical documents. You can also learn about the role of technical writers at Google.
プログラマーに贈る、わかりやすい文章を書くための技法 - LIVESENSE ENGINEER BLOG
英語が苦手な人が英文Writingを学ぶにあたっておすすめの本五選｜Yuki Nakazato
技術文書の書き方
howto-tech-docs.md 技術文書の書き方 このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。 しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。 技術文書とは ここでは、ソフトウェア開発で技術者が書くべき文書ということにします。 ソフトウェアエンジニアにも役割がいろいろあり、アーキテクトと independent contributor では書く文書が違うということはあるでしょうけれど、ここではごっちゃにします。
ドキュメントに固執せよ - gfnweb
どうして人間集団はこんなにも知見の共有を円滑にできないのか？ 改善にはドキュメントにまつわる各個人の心構え・制度設計・技術的解決の全部が必要だという話をしたい． ここでテーマにしているのは，著名OSSなど世の中にいくらでも知見が転がっている対象ではなく，特に企業内の十数人のチームでクローズドに開発しているなどして集合知に頼れない状況下でのドキュメントについてである． 非常に乱暴な言い方をするなら，「コードとか大部分は誰でも書けるようになるものなんよ，そんなところにマッチョイズムとか感じなくてええねん，我々の知的体力や組織性が真に試されるのはドキュメントちゃうんか」という気持ちです — 画力・博士号・油田 (@bd_gfngfn) June 3, 2022 ドキュメントに書く内容の必須項目或るシステム（ソフトウェアなど）について，そのシステムのことを全く知らない人を想定読者としたドキュメント
仕様書の参考例と、こんな内容を仕様書に最低書くといいというお話｜田辺めぐみ
継続的ドキュメンテーション: Github DiscussionsとADRのすすめ - LIFULL Creators Blog
社内のドキュメンテーションの取り組みと、Kitenのご紹介 - Pepabo Tech Portal
Google、マイクロソフトらが設立、「Open Web Docs」を発表。MDNなど支援、Web技術のドキュメント化を推進
オープンソースやテクノロジーを中心としたコミュニティの維持や発展を支援する組織「Open Collective」は、Web技術のドキュメント化を長期的に支援する取り組みとして「Open Web Docs」を発表しました。 Open Web Docsはおもに既存のコミュニティによるドキュメント、特にMozillaのMDNをまずは優先的に支援するとしています。 We’re happy and proud to announce Open Web Docs, to support a community of technical writers around creation and long-term maintenance of web platform technology documentation that is open and inclusive for all.https://t
LINE社内テクニカルライティング講座第2弾！1文では説明が終わらない文章を書くコツ
こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。先日、このLINE Engineering Blogで「LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた」というタイトルで、1文を書くときに気をつけていることや手法について紹介しました。 前回の記事を簡単にまとめると「たくさんの文案を書いて、一番良さそうなものを選択することがとても大切です」という話を多くの例文を使って説明しました。まだ読んでいない方はぜひ読んでみてください。 今回の記事は、第2弾です。次のステップとして「1文では説明が終わらない文章をどのように組み立てていくとわかりやすいか」という話を、以下のような文章を例に説明していきます。 ここでは、このくらいの情報量の文章を「トピック」と呼びます。 第2弾を最後まで読む
LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた
プロダクトのドキュメントにプルリクエストを送れる仕組みがすごい - Qiita
AWS Documentation is Now Open Source and on GitHub | Amazon Web Services
AWS News Blog AWS Documentation is Now Open Source and on GitHub Earlier this year we made the AWS SDK developer guides available as GitHub repos (all found within the awsdocs organization) and invited interested parties to contribute changes and improvements in the form of pull requests. Today we are adding over 138 additional developer and user guides to the organization, and we are looking forw
LINE Developersドキュメントサイトのリデザインの話 - LINE ENGINEERING
! This post is also available in the following languages. 英語, 韓国語 こんにちは。LINEの開発者向けプロダクトのドキュメントを作成している、テクニカルライターのKenneth Lauです。すでにお気付きの方も多いと思いますが、2017年9月にLINE Developersサイトが大幅に更新されました。このサイトでは、LINEログインやMessaging APIのような開発者向けプロダクトに関するドキュメントや、アプリ管理用の開発者コンソールにアクセスできます。サイトの変更内容の概要については、サイトのニュース投稿「LINE Developersサイトのデザインが新しくなりました」を参照してください。 このブログ記事では、サイトを支える技術と開発者向けドキュメントの執筆プロセスに対する変更に焦点を当て、静的サイトジェネレータへの
英語ドキュメントが読みやすくなるテクニックで仕様書を読んでみる
LiteraがGoogle Cloudと提携し、専門家向けドキュメント比較をG Suiteに提供
LiteraがGoogle Cloudと提携し、専門家向けドキュメント比較をG Suiteに提供 AsiaNet 69663 （1214） 【マクリーンズビル（米ノースカロライナ州）2017年8月16日PR Newswire＝共同通信JBN】 Googleは法律業界のために、新しい機能によってG Suiteを強化している ドキュメント・ライフサイクル・ソリューションの世界リーダーLitera Corpは、Google CloudのG Suite製品チームと協力し、Change-Proの専門家向けドキュメント比較テクノロジーをG Suiteに導入した。これは法律業界の専門家向けにG Suiteを強化するイニシアチブの一環である（https://www.blog.google/products/g-suite/get-same-page-new-google-docs-features-pow
Railsガイドを支える技術 (30分版)
関西Ruby会議06で発表したスライド資料です :) Railsガイド: http://railsguides.jp/ DEMO動画一覧: https://yasslab.wistia.com/projects/4msq4voot3 【関連リポジトリ】 - yasslab/railsguides.jp: https://github.com/yasslab/railsguides.jp - yasslab/konjak: https://github.com/yasslab/konjak - yasslab/gtt-downloader: https://github.com/yasslab/gtt-downloader - yasslab/translation-api-examples: https://github.com/yasslab/translation-api-exampl
Overview — Sphinx v1.0 (hg) documentation
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
ドキュメントを改善するためのはじめの一歩
