【汎用ソフトスキル】ドキュメンテーションの続け方
この記事の目的 最近「良いドキュメントが作れているな」と思う機会が増えてきたので、その知見をアウトプットしたくなった。 想定読者 今所属してる組織(会社/プロジェクトなど)のドキュメントがイマイチで悩んでいる人 そもそもドキュメントが無い組織に所属していてつらい思いをしている人 「ドキュメントを作れ」という漠然としたタスクを振られて困っている人 想定読者ではない人 メンテなブルなドキュメンテーションのエコシステムが完成している組織で更によいやり方を模索している人 私もまだ模索中なので、いいやり方があれば教えてほしいです👀 顧客提出などの「納品が必要」なドキュメントの管理方法を模索している人 この記事では「社内の情報共有」にスコープを切って話をしています 書いている人のスペック(参考) 歴５年くらいのなんちゃってフルスタックエンジニア 普段は Node.js / React.js or R
【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO
はじめに こんにちは植木和樹＠上越妙高オフィスです。本日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 （この記事を読むのにかかる時間の目安：5分） 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1
1ページで完結、Web制作者が助かるチートシート・資料・PDFまとめ
作成：2015/08/10 更新：2017/04/16 Web制作 > 開発環境 ページを移動せずにテンプレートや仕様書を確認したい。今回はPCの横に貼ったり印刷したり、ワンクリックで見れるように、1ページで完結している資料をまとめました。Web制作をする上で便利なチートシートや資料・仕様書まとめです。 エンジニア速報は Twitter の@commteで配信しています。 もくじ WordPress版 受託用マニュアル １．ヒアリングシート ２．WP版ホームページ制作の流れ ３．WordPress管理マニュアル ４．WP版品質チェックシート ５．Wordpress タグ タスクランナー ６．gulp ７．Bower JavaScript 代替言語／JST ８．TypeScript ９．CoffeeScript １０．Jade コーディング用 １１．Chrome 開発ツール １２．html5
事務屋必見！コピペを更に便利にするクリップボード拡張ツール３選 - ゆとりずむ
こんにちは。らくからちゃです。 IT業界で働いていると、何故かありとあらゆる資料がエクセルで提出させられます。設計書とか、きちんと使いこなせれば、ワードで作ったほうが綺麗に出来たりするんですけどねえ。ところで、先日こんな記事を読みました。 『そんなもん誰でも知っとるわ(#ﾟДﾟ)！！』と怒りにも似たコメントで満ち溢れたブックマークを見て、胸が痛くなりました。誰だって最初は初心者、もし知らなかったとすると、それは隣に座っているあなたが教えなかったのが悪いのですよと。意外と、大学卒業したての学生君たちは、一括置換とかも知らないものなので、正規表現くらい覚えて出てこい！というのは酷というものです。 エクセルの小技 また、仮に知識として知っていたとしても、それを適切に運用できるかは別の話です。IT業界では、プログラムが正しく動作したことを記録した資料を『エビデンス』と読んでいます。記録方法として、
今更始めるJenkins勉強会 チートシート一覧 - Qiita
2014/04/05開催、今更始めるJenkins勉強会ハンズオンで使用するチートシート一覧です。 http://atnd.org/events/48562 発表資料はこちらです。 http://www.slideshare.net/n_rooms/effective-jenkins-for-study-meeting 詳細は各エントリを参照してください。 1.CentOS6.3へのJenkinsインストール 2.ユーザ作成を含む最低限のセキュリティ設定 3.プラグインのインストール方法 4.社内LAN環境など、インターネットに繋げない環境での運用について 5.CollabnetSubversion EdgeのインストールとJenkinsの連携 6.バックアップについて Register as a new user and use Qiita more conveniently You g
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Ryutaro YOSHIBA on Twitter: "スクラムってカタカナ語が多くて人に説明しにくいって言われたので、スクラム用語使わないで説明する資料作ってみた https://t.co/KiFxXjMNgs"
管理・運用移譲通知