読みやすいREADMEを書く | Yakst
いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADMEを書くためのアドバイス。 この記事は、Rowan Manning氏による「Writing a Friendly README」(2016/3/14)を翻訳したものです。 あなたのプロジェクトのREADMEは、かなり重要です。そこはプロジェクトに初めて来た人が大抵最初に見るであろう場所であり、唯一のドキュメントであることもよくあります。あなたのオープンソースプロジェクトにとってのREADMEは、企業にとってのウェブサイトのようなものです。ウェブサイトはユーザーエクスペリエンスの注目を集めるところですが、READMEがユーザー観点で考えられることはほとんどありません。 この記事では、分かりやすいREADMEを書くために役立ち、開発者(ユーザー)の要求に見合い、開発者がプロジェクトを初めて見たの
SEが苦手にしがちなドキュメント力を強化する5つの視点
SEに最も必要なスキルは「伝える力」だと言われています。分業が前提となるシステム開発において、意志の伝達がうまく出来ないことは致命的だからです。 よって、作成するドキュメントにも正しく伝える技術が求められるのですが、しかし多くのSEはドキュメント作成を苦手としているようです。 そこで今日は、SEがドキュメント作成で失敗しがちなポイントと、ドキュメント力を強化するための5つの視点について、『エンジニアのための文章術再入門講座』からご紹介します。 1.SEがドキュメント作成で失敗しがちなポイント SEがドキュメント作成に失敗しがちなポイントは、主に以下の2つです。 相手の関心と不一致 知識差のための説明が不足 例えば、システム開発プロジェクトの部長向けの進捗報告の場面を思い浮かべてください。性格にもよりますが、一般に部長クラスの方が気にするのは「予算を超過しないか」「顧客との関係は良好か」「今
プロジェクトマネージャ試験(PM)の論文答案の書き方 - ysadaharuhatenablog
はじめに 本エントリは、情報処理技術者試験の「プロジェクトマネージャ」の論文答案の書き方をまとめたものです。 H21春のPM試験に合格したときに僕が実践した午後2の論文答案の書き方と勉強法をまとめてみました。 ※その他の情報処理関連のエントリは[情報処理]タグからどうぞ サマリー 基本的な論文作成のお作法はSA試験編と同じで、「答案構成を作って、構成通りの答案を作る！」というやり方です。 答案構成というのはシナリオとか下書きとかいうイメージで、法律系の試験勉強で習った答案作成法を応用したものです。（プログラムを書くための基本設計みたいなものです） 論文作成作業項目をもう少しブレイクダウンすると、 設問から採点基準を漏らさず抽出する。 採点基準に沿って、問題文から論点を構成する。 論点をつなげて答案構成を作成する。 答案構成通りに論文答案を作成する。 となります。論点と言うのは配点ポイントの
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
