【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO
はじめに こんにちは植木和樹＠上越妙高オフィスです。本日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 （この記事を読むのにかかる時間の目安：5分） 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1
Googleドキュメントが音声入力に対応したので喋って書いてみた
Googleドキュメントがアップデートされ 音声入力に対応しました これにより キーボード タブレット端末などでも 気軽に文字入力が出来るようになります 温泉利用するには ツール 右矢印 音声入力とクリック音声入力ボタンが表示されるので こちらをクリックすると 音声認識が開始されます 錦中は男が赤くなり 入力された音声は自動的に変換されます 前後の文脈などを販売しているようで長い言葉などは 前後の文脈を参考にしてですね としてはよく出しています なお この原稿はグーグルドキュメントの音声入力だけで書き上げました どうでしょうか 読めますか ●以下原文 Googleドキュメントがアップデートされ、新たに音声入力に対応しました。これによりキーボードの無いタブレット端末などでも気軽に文字入力ができるようになります。 音声入力を利用するには｢ツール｣→｢音声入力｣とクリック。音声入力ボタンが表示さ
example.com - Wikipedia
example.com, example.net, example.org, example.eduは、ソフトウェアドキュメンテーションやドメイン名の例示のために予約されているセカンドレベルドメインである。 .com, .net, .orgのセカンドレベルドメイン"example"は、1999年に RFC 2606 第3章にてInternet Engineering Task Force (IETF) によって予約された[2]。.eduのセカンドレベルドメイン "example" は、2000年にInternet Corporation for Assigned Names and Numbers (ICANN) によって予約された。 これらのドメイン名が予約されていることによって、マニュアルやソフトウェア構成のサンプルでこれらのドメインを使用することが可能である。すなわち、エンドユーザー
REST APIドキュメント作成ツールはapiary.ioが決定版かもしれない - Qiita
背景 APIドキュメントを書くのが楽になるツールまとめ - Qiita iodocsで便利なREST APIドキュメントを作成する - Qiita これまでずっとREST APIドキュメントをwiki上で管理していて、重たいページ上で特殊記法使ったり、スタイルの調整に時間を取られるのが辛かった。そこで良さげなドキュメントツールを色々調べてたんだけど、最終的にapiary.ioが一番良さそうという結論になってきた。 このサービスの主な特徴。 markdown記法でAPIドキュメントを記述できる ドキュメントの生成と同時にAPIのモックサーバを用意してくれる サインアップから5分くらいあればドキュメント公開できる。ドキュメントのホスト先を気にしなくてもいい。 特にドキュメントと一緒にモックを作ってくれるのは他にはないポイントでかなり便利。 使ってみる サインアップはGithubアカウントで h
Gradle User Guide
Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically. このドキュメントは、個人利用目的および第三者に配布するためにコピーして使用できます。ただし、印刷するにせよ電子媒体を使用するにせよ、以下の点に留意してください。どのような形態であれ使用料を課さないこと。また、このコピーライト条項を配布物に含めること。 例目次 6.1. 初めてのビルドス
ReStructuredText 文法まとめ - secretbase.log
Sphinxで使う軽量マークアップ言語 ReStructuredText で役立ちそうなサイトをまとめてみました。(ReStructedText基礎文法最速マスターがありそうで無かった) 文法 サイト名 説明 ReStructuredText 入門 ReStructuredText Primerの日本語訳 はやわかり reStructuredText プレーンテキストと変換結果の例がわかりやすい reStructuredText Markup Specification rstの詳細な仕様。チュートリアルや入門ではない reStructuredText入門 :: ドキュメンテーションツール スフィンクス Sphinx-users.jp よく使う記法。入門 Tips サイト名 説明 reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。 論文っぽい文章を書くときのti
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
iOS Developer Library
GitBook – Knowledge management for technical teams