Design Docs at Google
One of the key elements of Google's software engineering culture is the use of design docs for defining software designs. These are relatively informal documents that the primary author or authors of a software system or application create before they embark on the coding project. The design doc documents the high level implementation strategy and key design decisions with emphasis on the trade-of
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.
Tutorial | Apiary
This isn't a tutorial you are looking for… This document is a tutorial for the discontinued legacy Apiary Blueprint format. As such it is provided for backward compatibility only. Please refrain to using this format for newly created APIs. Visit the API Blueprint Tutorial for the tutorial on the format currently used in Apiary. Deprecated: Apiary Blueprint syntax Hover a section → its description
node.jsのいろいろなモジュール31 – apiDocでRESTful APIドキュメントを生成する | DevelopersIO
RESTアプリケーション用ドキュメント apiDocモジュールは、RestfulAPI用ドキュメントジェネレーターです。 jsファイル内にJavadocやJsdocのように埋め込み、API用の説明を記述すると、apiDocコマンドでhtmlとして出力することができます。 デフォルトではこんな感じでドキュメントが出力されます。 なお、独自のテンプレートを使用することも可能みたいです。 環境構築方法 今回使用した動作環境は以下のとおりです。 OS : MacOS X 10.7.5 Node.js : v0.10.4 npm : 1.2.18 npmを使用してモジュールをインストールしましょう。グローバルオプションをつけてapiDocをインストールします。 % npm install apidoc -g これで問題なくapidocコマンドが使えるかと思ったのですが、私の環境だと、 「env: n
webサイトの企画書や提案書のサンプルを見たいのですが、提案書や企画書がまとめられているサイト等知っている方がいましたら教えていただけないでしょうか？
webサイトの企画書や提案書のサンプルを見たいのですが、提案書や企画書がまとめられているサイト等知っている方がいましたら教えていただけないでしょうか？
Sphinx-Users.jp
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx （スフィンクス）の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
bikkuri.me