大手ITスタイルガイドがベースGoogleやMicrosoftなど大手IT企業の英語スタイルガイドの基準がベース。一般的な英語表記から外れません。
はじめに 2020年10月、Githubがデフォルトのメインブランチ名をmasterからmainに変更しました。理由は、masterがslave(奴隷)を背後に連想させるため。 旧来の価値に根差した既存の用語を置き換える動きは、2020年を契機としてますます勢いを増し、その影響は仕様の策定から命名規則などのコーディング面にまで幅広く及んでいます。 こうしたアメリカのテック界の様相をInclusive Writingの切り口から、Google, Appleのスタイルガイドを摘要しながら概観するのが本稿の趣旨です。 Inclusive Writingとは? Inclusive Writingはかんたんには、多様な読者を意識した書き方、といえます。 Inclusiveは日本語でも「インクルーシブ教育」等、ダイバーシティの文脈でカタカナ語として定着しつつありますが、強いて訳せば「包含、包み込む」と
日本語ネイティブ向け英語スタイルガイドの「IT英語スタイルガイド」も公開しています。まとまった情報が必要な場合にご参照ください。 Googleが公開している開発者向け英文スタイルガイドから項目を1つ取り上げて紹介します。スタイルガイドは基本的には書く際に利用されますが、読む際にも参考になります。 節を書く順序(Clause order) URL:https://developers.google.com/style/clause-order ユーザーに対して指示文を書く場合、先に指示ではなく、条件(条件節*)を書くようにします。 Googleではまず以下の例を挙げています。 ✕ See [リンク] for more information. ◯ For more information, see [リンク]. いきなり「See …」と指示を書くのではなく、「詳細情報が必要なら」と条件をまず
Make every word matter Welcome to the Microsoft Writing Style Guide, your guide to writing style and terminology for all communication—whether an app, a website, or a white paper. If you write about computer technology, this guide is for you. Today, lots of people are called upon to write about technology. We need a simple, straightforward style guide that everyone can use, regardless of their rol
Send feedback Word list Stay organized with collections Save and categorize content based on your preferences. outlined_flag This style guide promotes clear, concise, and inclusive language in technical documentation. It provides specific word choices and formatting guidelines for Google Cloud and other technical content. The guide discourages jargon, ambiguous language, and potentially offensive
Send feedback Sentence structure Stay organized with collections Save and categorize content based on your preferences. If you want to tell the reader to do something, try to mention the circumstance, conditions, or goal before you provide the instruction. Mentioning the circumstance first lets the reader skip the instruction if it doesn't apply. For information about how to apply this guideline t
Many individuals and teams fail at documenting their projects properly, effectively drawing other developers away from their code. Fortunately, the most common documentation pitfalls are quite simple to overcome. In this article, I’m going through techniques that have helped make our projects more approachable to new developers whilst also appealing to power users, eventually bringing more people
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く