開発ドキュメントの書き方。意識したい9つのこと【技術編】

2022/05/07 375 users 技術編 書き方 テクニカルライター 9つ 述語

テクニカルライター。開発者向けのドキュメントを書いています。元エンジニア。共著で「現場で使えるRuby on Rails 5」を書きました。趣味はスプラトゥーンです。 目次 文章を書く前にやること 開発ドキュメントの書き方 1. 一文を短く切る 2. 結論を先に述べる 3. 指示語を使わない 4. 主語を明確にする、述語との距離... 続きを読む

チームの想いをなんでも共有する「ゆるふわ」「ポエム」タグが議論のきっかけに - freee株式会社 Qiita:Teamインタビュー - Qiita Blog

2014/07/08 116 users htomine Qiita サマリー ポエム TEAM

こんにちは！ htomineです。 みなさんのチームには「気兼ねなく情報発信できる場所」はありますか？ 今回は、Qiita:Teamをそんな場所としてご活用いただいている、freee株式会社さんの事例をご紹介します。 サマリー ポイントをまとめると 使い方の指針になるような記事をはじめに投稿してから徐々に広めた 開発ドキュメントにかぎらず、仕事のフローの改善案、自分の想いやライフハック的な記事など... 続きを読む

わたしが知らないスゴ本は、きっとあなたが読んでいる: 画面仕様書を「作らない」リスク

2005/12/09 120 users スゴ本 リスク わたし プロトタイプ あなた

IT Pro の開発ドキュメントの最適化で笑わせていただいた。これ書いた人は画面仕様で酷い目に遭ったことがないんだろう。笑った箇所は次の通り。 画面仕様書をプロトタイプ・アプリケーションで代用する方法がある。Webシステムの場合は，HTMLの作り方を工夫すればプロトタイプで実際の入力手順や画面遷移も確認できるようになる。エンドユーザーにとっても，ドキュメントよりは実際の画面で確認した方が分かりやす... 続きを読む