Google社のテクニカルライティングの基礎教育資料がとても良かったので紹介したい - Qiita
はじめに エンジニアにとって、仕様書などの技術的な文章を書くこと（テクニカルライティングとも言います）は避けて通れません。ただ20年来多くのエンジニアの方々と同僚として接してきて思うことは、エンジニアの方の中には「文章を書く」ということに苦手意識がある方が一定数いるということです。 でもこの「テクニカルライティング」のスキルは、才能というよりは一種の「技能」だと思うんです。ある一定の原理原則を理解して実践を繰り返すことで、必ず一定レベルで習得できるものだと著者は信じています。 もしこのテクニカルライティングの原理原則をまだ体系的に学習したことがない、または過去学習したが改めて再学習したいという方に、お勧めのコンテンツを見つけたのでご紹介します。 https://developers.google.com/tech-writing Every engineer is also a write
発表資料 — OpsLab
業務/システム運用に関する執筆記事/論文/発表 (2013〜)¶ 【インタビュー記事】 運用でカバーの波田野さんが現場で得た経験則とCLI支部への思い (JAWS-UG on ASCII.jp / 2016年7月) 【インタビュー記事】セキュラボ 『もう一人の視点対談 乗口雅充 X 波田野裕一 (前編) (2016年5月) 『もう一人の視点対談 乗口雅充 X 波田野裕一 (後編) (2016年7月) 【連載】Sphinxで始めるドキュメント作成術 (Software Design / 共著) 第16回 Sphinxで運用ドキュメントを作る 【講演】 クラウドネイティブ時代のインフラエンジニア (Internet Week 2015 / 2015年11月) 【レポート】 Monthly News from jus 42: セキュリティとクラウドの新潮流に触れたInternet Week (S
swaggerでAPIドキュメントを書いたらめっちゃはかどった話 - kaz29
Swaggerは、REST APIの仕様とそれに関連するツール群の総称です。REST APIの仕様を定義したJSONファイル(Swagger Spec)を軸に以下のようなツールから構成されています。 Swagger UI - Swagger Spec から動的にAPIドキュメントを生成するツール Swagger Editor - Swagger Specのエディタ Swagger Codegen - Swagger Specからクライアントのコードを生成するツール 最近では、Open API InitiativeがAPIの記述のためにSwaggerを採用して話題になりました。 www.publickey1.jp APIドキュメントのメンテは結構面倒 一般的にAPIの仕様書は、古くはExcel/Wordなどを使ったり、最近ではWikiやMarkdown形式で記述したりなどプロジェクトによって
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
運用ドキュメント2019/20190824-odc-operation-document
