ドキュメントを誰のために書いていますか
Solo Technical Writer のやざきです。いまは株式会社ソラコムで、SORACOM Users (通称、SORACOM ユーザーサイト) というサイトの管理をしています。「ユーザー」と書いていますがれっきとした公式サイトです。 先日、個人的な立場として (とても大切)、次世代 Web カンファレンス 2023 Technical Writing セッション (Togetter) で議論をさせていただきました。もしまだ聞かれていない方がいらっしゃったらぜひ聞いてみてください。 今回は、そこでは話し足りなかったことの一つ「ドキュメントを誰のために書いていますか」について補足しておこうという記事です。 誰のために書いていますか 「読者のため」に書きましょう。これが原理原則だと思います。 ですが、「読者」を正確に把握できますか？と考えると、現実には難しいことが多そうです。つまり「読
社内技術ドキュメンテーションを科学する - スタディサプリ Product Team Blog
最終更新日: 2024年02月27日(月) 1. ご挨拶 2. 本記事執筆のモチベーション 3. ワークショップを通じて得たフィードバック 3-1. Pains -過去抱えた/現在進行形で抱えている辛み- 3-2. Approaches/Solutions -Pains を解消するために取った方策や導き出した解決策- 3-2-1. えいやで場所を決め打ちしてしまう(e.g., GitHub Wiki + Google docs しか使わない) 3-2-2. 個人的に、2023/12/05時点で〜みたいな書き方を心がけている 3-3. Tips -効果的な手法- 4. オーディエンスからの反響 4-1. 気づきや学び・NEXT ACTIONS 4-2. プレゼンター(@hayat01sh1da)へのフィードバック 4-3. Slack での反応 5. おわりに 1. ご挨拶 初投稿となります
Announcing Angular.dev
Angular first launched in 2016 as a way to help developers build modern web applications. Throughout its history, Angular has made millions of developers successful. Over the past several releases, we’ve focused on improving performance and developer experience on the modern web. Our momentum includes a revamp of Angular’s reactivity system, SSR, and dozens of additional features. Later this week,
Chrome user device characteristics report | Blog | Chrome for Developers
Developers are constantly wondering about what kind of audience they are developing for. Are they using high end devices with large RAM? What connection are they using (for example Wi-Fi, 2G) and so on. The answers to these questions can affect product development decisions such as choosing the technologies to render the content. This report provides timeline data to inform developers on these que
公式ドキュメントの読み方
「公式ドキュメントを読め」というのが急に話題になっていたので自分なりに整理してみました。 注意: そんなに真面目に推敲していません。フィーリングで書いているので実態に即してない部分もあるかも…… 公式ドキュメントとは何か あなたが使おうとしている道具 (ライブラリ、フレームワーク、プログラミング言語、ミドルウェア、コマンドラインツール、etc.)[1] は必ず誰かによって作られています。ある程度成熟した道具であれば通常、その作った人・組織自身によって公開されているドキュメントがあるはずです。これが公式ドキュメントです。 公式ドキュメントは、OSSにおいてはソースコードと双璧をなす最も信頼できる資料のひとつです。ソースコードが非公開の場合は通常、公式ドキュメントが最も信頼できる資料でしょう。 (以降はOSSを主に想定して説明します) たとえば…… Python のソースコードはGitHub上
A Roadmap for Angular
At the beginning of 2020 at ng-conf Hardwired, I talked about how we were evolving the team, improving our processes, and working to build stronger connections with the Angular community. One of the most important steps we are taking towards these goals is sharing more about what we’re working on, and some of the projects we’re considering for the future. Today we’re adding a page on angular.io wi
Introducing the MDN Web Docs Front-end developer learning pathway – Mozilla Hacks - the Web developer blog
Thanks! Please check your inbox to confirm your subscription. If you haven’t previously confirmed a subscription to a Mozilla-related newsletter you may have to do so. Please check your inbox or your spam filter for an email from us. Saboya Gustavo Great initiative! Never coded before 2020, and I intend to become a front-end developer since the beginning of this year. Sometimes, my path has slowed
MarkdownやAsciidoc中に書いたJavaScriptのサンプルコードをdoctestするツールを作った
技術書、ブログ、READMEを書いてていて、文章中に出てくるコードブロックのコードをテストしたいことがあると思います。 そのサンプルコードが本当に動いてるのか不安になることがあるからです。 power-doctestは、そのコードブロック中のコードにコメントを入れるだけでテスト可能にするツール群です。 power-doctestの例 具体的な例から見ていきます。 次の例では、Markdownで説明とJavaScriptのコードブロックを書いています。 デフォルト引数を使って書くことで、このような挙動は起きなくなるため安全です。 デフォルト引数では、引数が渡されなかった場合のみデフォルト値が入ります。 ```js function addPrefix(text, prefix = "デフォルト:") { return prefix + text; } // falsyな値を渡してもデフォルト
New flexbox guides on MDN – Mozilla Hacks - the Web developer blog
In preparation for CSS Grid shipping in browsers in March 2017, I worked on a number of guides and reference materials for the CSS Grid specification, which were published on MDN. With that material updated, we thought it would be nice to complete the documentation with similar guides for Flexbox, and so I updated the existing material to reflect the core use cases of Flexbox. This works well; wit
ライブラリをES2015(ES6)で書いて公開する所から始めよう
この記事はECMAScript 2015の事始めとして、ライブラリをECMAScript 2015で書いて公開するというところから始めるのがいいのではという内容です。 ECMAScript 2015(ES2015)はES6とも呼ばれていてどちらも同じものを指しますが、この記事ではES2015に統一します。 ECMAScriptのバージョンについては次のページを参照してください。 ECMAScript · JavaScriptの入門書 #jsprimer 2018-12-27: 追記 textlint/textlint-rule-helperのmasterはTypeScriptの実装へ変換されています。 Babelの実装はhttps://github.com/textlint/textlint-rule-helper/tree/2.0.1から参照できます Babel から TypeScrip
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
https://github.com/farm-fe/rfcs/blob/main/rfcs/003-partial-bundling/rfc.md
Writing the Docs