テクニカルライティングの基本テクニカルライティングの基本を学べます。サイボウズの新入社員向け研修資料です。業務マニュアル、報告書、仕様書、技術解説書などのドキュメントを書く機会がある方向け。 Twitter：https://twitter.com/naoh_nak 2023年度のアップデート版もあります：https://speakerdeck.com/naohiro_nakata/technicalwriting2023
緩やかに死んでいくシステム / You won't be in the team forever
Talked at Cloud Native Lounge #2「クラウドネイティブなシステムの継続的改善と企業文化」. https://forkwell.connpass.com/event/215798/
2020年買ってよかったもの10選
今年は生活の変化幅が大きく、それに合わせていろんな道具を試した一年でした。その中でも特に生活を支えてくれた、豊かにしてくれたものをまとめたいと思います。
Overview of technical writing courses | Technical Writing | Google for Developers
The pre-class components introduce topics; the in-class components help students integrate and practice those topics. That said, the pre-class work, by itself, provides significant educational value. Google provides all the materials needed to run the in-class sessions at your own organization. If you'd like to facilitate the in-class sessions for your organization, please see Facilitating Technic
読みやすいREADMEを書く | Yakst
いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADMEを書くためのアドバイス。 この記事は、Rowan Manning氏による「Writing a Friendly README」(2016/3/14)を翻訳したものです。 あなたのプロジェクトのREADMEは、かなり重要です。そこはプロジェクトに初めて来た人が大抵最初に見るであろう場所であり、唯一のドキュメントであることもよくあります。あなたのオープンソースプロジェクトにとってのREADMEは、企業にとってのウェブサイトのようなものです。ウェブサイトはユーザーエクスペリエンスの注目を集めるところですが、READMEがユーザー観点で考えられることはほとんどありません。 この記事では、分かりやすいREADMEを書くために役立ち、開発者(ユーザー)の要求に見合い、開発者がプロジェクトを初めて見たの
Markdownドキュメントをgithubで管理して、はてなブログでホストする ~ Mackerelの場合 - Hatena Developer Blog
はてなチーフエンジニアの Songmu です。この記事ははてなデベロッパーアドベントカレンダー2015の7日目の記事です。昨日は id:mazco による デザインにおける個性のつけ方 でした。 今日は Mackerel の公開ドキュメントについてのお話です。 Mackerelは以下で公式ドキュメントを英語と日本語で提供しています。 help.mackerel.io help-ja.mackerel.io これらは実ははてなブログでホストしています。 翻訳は日本語を先に書いて、それをチームのネイティブ翻訳者が翻訳するフローになっています。 ドキュメントの運営 告知ブログのようなものなら良いのですが、ドキュメントはその性質上定期的なメンテナンスが必要になります。特に以下の様な点がドキュメントを運営する際に難しいところです。 なんらかの一括修正が必要になった場合に修正点を洗い出して一括で反映す
ドキュメントの件
http://yoshiori.hatenablog.com/entry/2015/04/14/171326 実際にちゃんと日程決めて 1 日なるべくドキュメンテーションする日にしようという事にしてやりました。 ターゲットは主に社内の各種サービス。内部 API とかライブラリとか、そういう類の。 「ドキュメント改善しないとまずいよねー」「はー」「なんか一日集中してやる日とかつくればいいんじゃ」「そこまでするかねえ」「いやーそうしないと人間絶対やらないからチーム全体で今日はそれをやるぞ!って決めて動かないとやらんでしょ」みたいな流れがあってな — そらは (@sora_h) April 14, 2015 「今日はみんなこれをやる」と決めると、やるかー、っていう気分になるじゃん。いろいろやらなきゃいけないタスクはあるけど、それは置いておいて みんなで やるという空気にするとわたしはやるかーって
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
インフラエンジニアの綺麗で優しい手順書の書き方