Upgrade for image upload, smarter AI, and more Pro Search.
Upgrade for image upload, smarter AI, and more Pro Search.
howto-tech-docs.md 技術文書の書き方 このメモは、私(@ymmt2005)が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。 しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。 技術文書とは ここでは、ソフトウェア開発で技術者が書くべき文書ということにします。 ソフトウェアエンジニアにも役割がいろいろあり、アーキテクトと independent contributor では書く文書が違うということはあるでしょうけれど、ここではごっちゃにします。
IT企業が社内の新人エンジニアに向けた研修資料や動画を無償公開し、話題になっている。学べる内容はIT業界の文化からゲームエンジン「Unity」を使ったゲーム開発までさまざまで、中には150ページ超のスライドや5時間超の動画もある。 ネット上では「初心者(エンジニア)の指針になる」「IT基礎知識の一通りのことが身につく」「動画があって助かる」などと評判だ。改めて公開内容と目的をまとめた。 サイボウズ、新人ITエンジニア向けに「IT業界文化」など サイボウズが7月20日に公式ブログで、4月から6月にかけて行った研修の資料を公開した。7月30日時点でブログへの「はてなブックマーク」(以下、はてブ)は約1950件、Facebookの「いいね」は約590件付いている。同社は“駆け出しエンジニア”向けとしている。 (関連記事:サイボウズの“駆け出しエンジニア”向け研修資料が話題 Webアプリ開発やIT
はじめに こんにちは植木和樹@上越妙高オフィスです。本日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 (この記事を読むのにかかる時間の目安:5分) 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1
ビジネスの現場では、さまざまな資料を作る機会がある。報告書や提案書、会議の議事録に発表資料など、仕事の内容や状況によって形は変わるが、すべからく「ビジネス文書」であり「資料」だ。 「資料なんて、そんなものにこだわる必要はない」「資料作りに時間を割くのはばからしい」――。その意見には、筆者も賛成だ。不必要に凝ったものを作る意味はない。要は中身が正しく伝わればいいのだ。PowerPointやExcel、Wordを駆使して凝った資料を作っても、中身がなければ話にならない。そもそも、資料を作っただけで仕事が終わるなんてことは、普通ない。 ただ、それは「資料作りが不要」という話ではない。資料作りに過剰な時間をかけるのは無駄だけれど、かといって「伝わらない資料」を作ってしまっては、さらに時間の無駄だ。ましてや、その時間は自分のものだけではない。その資料を読む相手の時間も無駄に消費することになる。 体系
グラフやチャート、マップ、人物、吹き出し、リボンなど、インフォグラフィックやプレゼン用のベクター素材をfreedesignfileから紹介します。
著者の清水久三子さんは日本IBM グローバル・ビジネス・サービス事業部、ラーニング&ナレッジ部門リーダー。社内外、延べ2000人以上の方に資料作成(ドキュメンテーション)の研修を行ってきた方だそうです。 私の前職は外資系戦略コンサルティング会社の資料作成部門です。毎日100枚以上、累計7万5000枚以上の資料をひたすら見て、作り続けて行く過程において、相手が納得する資料とはどんなものかを6年間、現場で学びました。 また、昔から私は「何を言ってるか意味がわからない」と言われて話を遮られてしまったり、人前に立つと頭が真っ白になって立ち尽くしてしまうような人間で、それが強いコンプレックスでした。だからことさらに「伝える」「伝わる」とはどういうことかを気にして、日々学び続けてきました。 自分が相手とうまくコミュニケーションを取れずに悔しい思いをし続けてきたからこそ、解決する手段をずっと研究し続けて
GMOアドパートナーズ(株)がソーシャルメディア・Web広告戦略を提供するラボサイト!Web広告のトレンドや、SEO/SEM、ソーシャルメディアの最新手法の紹介から、ニュース、インタビュー記事等を掲載していきます。実績を通じて得た経験や専門的且つ、実践的なテクニックを活かして、他社の先を行く実効性のあるマーケティング戦略論を提供します。はじめに WEBサービス開発者のみなさん、こんにちは。GMOサーチテリア代表の中橋です。 当社エンジニアの執筆ペースが芳しくないので、本日も社長の中橋が代打で広告メディアについて書かせて頂きたいと思います。ヨーソロー! (※某代打系ブログをリスペクトしつつ参考に) ところで 新卒の採用シーズンですね! おかげさまで日々大学生のエントリーシートを拝見させていただいております。本当にありがたいことです。 ・・・そこでふと思ったのです。 「エントリーシートを制
企画書作りに役立つエントリーやサービスを一通り見て 「これだけ抑えておけば完璧!」と思う点を保存版としてまとめました! 優れた企画書を作るために 1,最強の企画書の作り方を学べる記事5選 2,企画書作りに使える最強の資料作成サービス の2つに分けて徹底的にまとめましたので 仕事で資料をよく作る人はぜひご覧くださいませ! 企画書を作る前に絶対読むべきエントリーBEST5 企画書を作る上で絶対に役立つ記事をベスト5形式でまとめました。 どの記事もかなり勉強になる記事なので一度だけでもご覧ください。 第1位 シンプルイズベストな1枚企画書を作ろう! これぞ完璧企画書――「1枚企画書」パターン実例3題 「問題+解決=問題解決型」「背景+課題=課題提起型」のように 企画を具体化し、分かりやすく1枚に集約した企画書の作り方が秀逸。 第2位 上司がOKを出す企画書を作る方法! “通る企画書”作りの基本/
クライアントとの更新やりとりを10倍楽にする(か... / 【無料配布】Web制作における書類一式、そしてド... / WEBサイト制作前やデザイン制作時に欠かせないヒ...他...全5件
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く