エンジニアが一生困らないドキュメント作成の基本（仲田 尚央） | 書籍 | ソシム

2024/11/24 338 users テクニカルライター ソシム 後回し 本書 スペシャリスト

「コードを書くのは好きだけどドキュメントは苦手」 「ドキュメントはつい後回しにしてしまう」 エンジニアの皆さん、そんな覚えはありませんか？ 本書は、日本語ドキュメントのスペシャリストであるテクニカルライターの著者が、エンジニアが「いつ」「何のドキュメントを」「どうやって」書けばよいのかを、イチから解... 続きを読む

VSCodeをドキュメント作成に活用――テキストエディタ、Markdownエディタの設定と拡張機能を解説

2024/11/08 154 users vscode テキストエディタ Markdownエディタ

本連載では、VSCodeにフォーカスし、基本的な使い方から拡張機能の活用、そして本格的な開発現場での利用を想定した高度な機能までを紹介していくことで、読者がVSCodeマスターになるお手伝いをします。VSCodeは、プログラミング以外の用途にも使えます。第10回では、VSCodeをドキュメント作成のためのテキストエディタ... 続きを読む

VS Codeでマークダウンを快適に書きたい！ オススメの拡張機能と設定6選 - ICS MEDIA

2024/05/23 218 users ICS MEDIA プレ ドキュメント 筆者 文字修飾

ブログの文章やドキュメント作成など、さまざまなシーンで使われる記法に「マークダウン記法」があります。文字修飾の簡単さや読みやすさから使うタイミングは多々あると思いますが、みなさんは快適にマークダウンを書けていますか？ 筆者はVS Codeでドキュメントをマークダウンで書くことが多く、表の作成・編集やプレ... 続きを読む

平岡 | 定時で帰るための「個人DX」推進 on Twitter: "これかなり革命的では。。 ChatGPTとノーコード使って、zoomが終わると勝手に ①文字起こし ②要約 ③ドキュメント作成 ④Slack通知 を行うワ

2023/03/22 159 users Zoom chatgpt 平岡 ワークフロー 定時

これかなり革命的では。。 ChatGPTとノーコード使って、zoomが終わると勝手に ①文字起こし ②要約 ③ドキュメント作成 ④Slack通知 を行うワークフローがでけた。 これが、非エンジニアでも30分で出来る世界なんです… https://t.co/yuoLGlSan1 続きを読む

Windowsでコマンドラインから画面キャプチャーをする (1/2)

2022/05/15 187 users コマンドライン コマンド PNG形式 画面キャプチャー メモ

コマンドラインから画面キャプチャーを実行して PNG形式で保存する 画面キャプチャー（スクリーンショットとも）は、ソフトウェアのドキュメント作成やメモ代わりにすることが多い。こうしたとき、コマンドラインから画面キャプチャーをしたくなることがあるが、残念ながら、Windowsには直接可能なコマンドは用意されて... 続きを読む

一体どういうこと？毎週水曜日を「進捗を出さない日」にする、というアイデアに称賛の声多数「天才的すぎる」「絶対やるべき」 - Togetter

2021/06/06 383 users Togetter 称賛 進捗 eaglesakura アイデア

川峠@Andriders @eaglesakura 弊チーム、毎週水曜日を「進捗を出さない日」に制定。 サボっていたドキュメント作成や変わってしまった部分を追従したり、細かい糞コードを直したりする日とした。 2021-06-02 16:23:26 川峠@Andriders @eaglesakura 愛車はcinelli/EXPERIENCE。 基本的にAndroidな人。「マルチプラットフ... 続きを読む

O'Reilly Japan - マイクロインタラクション

2014/03/04 126 users マイクロインタラクション インタラクション プロトタイプ

UIのディテールをほんの少し工夫するだけでUXは劇的に改善します。本書では効果的なマイクロインタラクション――ひとつの作業だけをこなす最小単位のインタラクション――の意味、有効性、デザイン手法を学びます。マイクロインタラクションを「トリガー」「ルール」「フィードバック」「ループとモード」に分解して豊富な実例とともにていねいに解説し、さらにプロトタイプやドキュメント作成、テストといった実践的な手法も... 続きを読む

SEが苦手にしがちなドキュメント力を強化する5つの視点

2012/05/07 351 users 視点 エンジニ 分業 5つ 意志

SEに最も必要なスキルは「伝える力」だと言われています。分業が前提となるシステム開発において、意志の伝達がうまく出来ないことは致命的だからです。 よって、作成するドキュメントにも正しく伝える技術が求められるのですが、しかし多くのSEはドキュメント作成を苦手としているようです。 そこで今日は、SEがドキュメント作成で失敗しがちなポイントと、ドキュメント力を強化するための5つの視点について、『エンジニ... 続きを読む

ウノウラボ Unoh Labs: ブラウザでER図が描ける「WWW SQL Designer」紹介

2007/10/05 279 users ウノウラボ miyake Unoh Labs ＥＲ図 ｗｗｗ

miyakeです。皆さんドキュメントはしっかり書いていますか？　近頃のWeb界隈では、詳細仕様書的なものは作らずにスピーディーに開発を進めるケースも多いかも知れません。ドキュメント作成のコストは小さくありませんし、内容を最新に保つのも一苦労です。とは言え、複数の人間が関わるプロジェクトにはER図はあると嬉しいなと個人的には思います。 今日はそんなER図をブラウザ上で作成するアプリケーション「WWW... 続きを読む

Zend Framework: Documentation: Zend Framework PHP 標準コーディング規約 - Zend Framework Manual

2006/05/11 568 users 書式 指針 ドキュメント コーディング規約 コード

このドキュメントは、Zend Framework に貢献してくださる開発者個人 (あるいはチーム) のためにコードの書式やドキュメント作成の指針を示すものです。 Zend Framework を用いて開発をする人たちにとってもこのコーディング規約は有用でしょう。 これに従えば、Zend Framework のコードとの一貫性が保てるからです。 そのためには、ここで完全なコーディング規約を示す必要が... 続きを読む