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

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

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

効果を維持しつつテスト工数を削減した話　〜テスト設計改善の質問回答編〜 - Visional Engineering Blog

2020/10/27 12 users チケット 回答 参照 テスト設計 テスト工数

以降では、このテスト設計改善の取り組みに対する質問に回答していきます。 テスト設計改善についての質問の回答 【質問1】テスト設計にあたって開発ドキュメントの参照はしないのでしょうか。開発ドキュメントがほとんど無い？ 開発ドキュメントの参照はします。チケットの内容、開発ドキュメントだけでなく、その内容... 続きを読む

DMM GAMESがオープン化。デベロッパ登録を行った組織は同プラットフォーム向けのゲーム開発が可能に - 4Gamer.net

2018/05/14 18 users DMM Games 組織 4Gamer.net ゲーム開発

DMM GAMESがオープン化。デベロッパ登録を行った組織は同プラットフォーム向けのゲーム開発が可能に 編集部：早苗月 ハンバーグ食べ男 DMMGAMESは本日（2018年5月14日），同社が運営するゲームプラットフォーム 「DMM GAMES」 の オープン化 を発表した。公式サイトでは， デベロッパ募集 が開始されている。 デベロッパ登録を行った組織には，DMM GAMES用の開発ドキュメント... 続きを読む

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

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

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

バージョン管理されているOpenDocumentファイルの差分チェックに「oodiff」 - MOONGIFT|オープンソース・ソフトウェア紹介を軸としたITエンジニア、Webデザイナー向けブログ

2011/10/04 14 users MOONGIFT プレゼンテー OpenDocument

特に開発メンバーなどについては必要としていないメンバーも多いのではないだろうか。むしろ開発ドキュメントなどはLibreOfficeの方が他のオープンソース・ソフトウェアとの親和性が高いかもしれない。その一つ、oodiffを紹介しよう。 0 oodiffはOpenDocument形式のファイルの差分をチェックできるソフトウェアだ。OpenDocumentなので、ワードプロセッサ、表計算、プレゼンテー... 続きを読む

各種記法に対応したWebベースのドキュメントビューワー「Invisible.js」 - MOONGIFT|オープンソース・ソフトウェア紹介を軸としたITエンジニア、Webデザイナー向けブログ

2011/07/04 17 users MOONGIFT サーバサイド 長文 ソフトウェア ソース

Invisible.jsはJavaScript製のオープンソース・ソフトウェア。開発ドキュメントをWebベースにする動きがある。最もシンプルに実装するのはWikiベースにすることかも知れない。だがWebブラウザのテキストエリアに長文を記入していくのは面倒くさいだろう。 0 表示例 そこで使われるのがテキストファイルを書いて、それをWebサーバから読み込ませる仕組みだ。そんな時はサーバサイドの用意を... 続きを読む

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

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

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