BLOGTIMES
« :: »
2017/10/02

Google の開発者向けドキュメントのスタイルガイド

  reference  google 
このエントリーをはてなブックマークに追加

Google が社内向けに使っているドキュメンテーションのスタイルガイドを見つけたのでメモ。

ドキュメントを作成する上で、避けるべきことなどが具体的にまとめられているガイドになっています。
例えば「API Reference Code Comments などは API のリファレンスマニュアルを作る上で非常に参考になります。

About this guide | Google Developer Documentation Style Guide | Google Developers

The primary goal of this guide is to codify and record decisions that Google's Developer Relations group makes about style. The guide can help you avoid making decisions about the same issue over and over, can provide editorial assistance on structuring and writing your documentation, and can help you keep your documentation consistent with our other documentation.

    by hsur at 22:55 [5年前][4年前][3年前][2年前][1年前][1年後][2年後][3年後][4年後][5年後] |
    こんな記事もあります 「リファレンス ドキュメンテーション ガイド」
    ・ローマ字表記のルールが変わる？
    ・Windows Update の日 ( 2024 年 2 月 )
    ・メールけいしちょうは当分の間 Gmail への配信が不可能に
    ・さくらの DKIM／DMARC 対応は 1/31 11:00 ～ 順次リリース
    ・神奈川の入試ネット出願システムの不具合が復旧
    ・Windows Update 初めをしよう ( 2024 年 1 月 )
    ・Windows Update の日 ( 2023 年 12 月 )
    ・Twitter のインプレゾンビが問題に
    ・Windows Update の日 ( 2023 年 11 月 )
    ・Google が Gmail へのメール配信を行う場合のガイドラインを公表
    トラックバックについて
    Trackback URL:
    お気軽にどうぞ。トラックバック前にポリシーをお読みください。[policy]
    このエントリへのTrackbackにはこのURLが必要です→https://blog.cles.jp/item/9664
    Trackbacks
    このエントリにトラックバックはありません
    Comments
    愛のあるツッコミをお気軽にどうぞ。[policy]
    古いエントリについてはコメント制御しているため、即時に反映されないことがあります。
    コメントはありません
    Comments Form

    コメントは承認後の表示となります。
    OpenIDでログインすると、即時に公開されます。

    OpenID を使ってログインすることができます。

    Identity URL: Yahoo! JAPAN IDでログイン

    « :: »
    Copyright © 2004-2023 by CLES All Rights Reserved.