【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO
はじめに こんにちは植木和樹＠上越妙高オフィスです。本日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 （この記事を読むのにかかる時間の目安：5分） 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1
PlayFrameworkをただの静的型付けMVCだと思って本番稼動させると死ぬ - サナギわさわさ.json
(3/15 : タイトル修正しました。wは小文字ですね、すみません・・・) PlayFrameworkが流行り始めてから割と経ちますので、そろそろ正式採用しようと考える方も多いのではないかと思います。 強力な静的型付けで守られたPlayは、ミッションクリティカルなシステムや数万行を超える大規模システムの構築に特に向いているような気がします。 また、Servletを使っていないのに加えてMVC構造がベースなので、今までRailsなどで開発をしていた人でもシームレスに移行できると思います。 しかし、忘れてはならないのがPlayのアーキテクチャが全ての処理が非同期で行われることを前提としているという事です。 ここを忘れてPlayをただの強力な静的型付けで守られたMVCフレームワークとだけ考えて開発を進めてしまうと、本番環境で稼動させた時にパフォーマンスが上がらずに困ることになるかもしれません。今
公式ドキュメントを読もう — みんなのウェディングエンジニアリングブログ
みんなのウェディングの高井です。 最近、若手のエンジニアと話をする機会が多くあります。そういった場で、ここが重要ですよと伝えたい話のうちのひとつがこの話になります。別のところに書いていたものですが、すこし手を入れた上で再掲します。 ハッカーの世界には昔から「RTFM」という言葉があります（参照）。ようするに「マニュアルを読め」という言葉なのですが、これはとても重要な言葉です。 色々な人によってブログにメモやノウハウが記載され、簡単に検索でみつかる世の中ではあります。また、そのためのサービスや技術的な質疑的な質問をすることのできるサービスも沢山あります。 しかし、検索サービスは、その内容が正しいことまで保証してくれません。見つかった記事の著者が誤解している場合もあれば、理解していない場合もあります。そして、ほとんどの場合は最新の情報ではありません。 マニュアルや公式ドキュメントであれば、それ
日本語文章のスタイルガイドのまとめ - Qiita
JTF日本語標準スタイルガイド（翻訳用） 実務翻訳において和訳時に使用できる日本語表記ガイドラインです。 このルールを適応出来るtextlintプラグインを書いた azu/textlint-plugin-JTF-style JTF日本語標準スタイルガイドのルールセットで文章をチェックできるtextlintプラグイン | Web Scratch 外来語（カタカナ）表記ガイドライン第3版 カタカナの長音や複合語の際の表記についてのガイドライン JIS Z 8301:2011 規格票の様式及び作成方法ではちゃんと決められてない部分についても書かれている Download International Style Guides - Microsoft | Language Portal Microsoftの各言語別の翻訳スタイルガイド(日本語向けもある) 『社会学評論スタイルガイド』 日本の社会学分
Markdownで書く電子書籍開発環境
Markdownで書く電子書籍開発環境 #niku_sushi 自己紹介 Name : azu Twitter : @azu_re Website: Web scratch, JSer.info JavaScript Plugin Architecture JavaScript Plugin Architecture 電子書籍の開発中にやったこと やりたかったこと [Markdown] 電子書籍開発環境 · Issue #42 Markdown/文章のLint インラインコードのLint ファイルのincludeするMarkdown拡張 Markdown to HTML or PDF エディタ [Markdown] 電子書籍開発環境 · Issue #42 Markdown/文章のLint => textlint インラインコードのLint => ESLint ファイルのincludeする
Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール
ベータ版を始めるにあたって、ベータユーザー募集中です。 お気軽にご連絡ください。どうぞよろしくお願いします。 http://cumiki.comRead less
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
サービス終了のお知らせ
