Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? Cursor擦り倒すシリーズ Cursorで要件定義がエラいスムーズになった話　←本稿こちら （続）Cursorで「詳細設計→ガントチャート草稿」作成がめっちゃ楽になった話 「Cursor」×「A5:SQL Mk-2」でテーブル定義書をリッチにする 「Cursor」×「Obsidian」内部リンク生成＆最適化プロンプト 「Cursor」で「難解コード」のリーディングがめちゃ楽になった話 「Cursorで要件定義をめっちゃ簡単に」を「rules」にしてさらに簡単にした 「Cursor」で「素の議事録」を「要件定義書」に高速でまとめなおした

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? はじめに 今回は有名企業で無料で公開しているエンジニア新人研修資料をまとめました。 昨今、新人向けの研修資料を公開する企業が増えています。 クオリティーがかなり高いものが多く、初級者から中級者でも学びがある資料となっています。 資料の作り方も勉強になるので「勉強会で登壇している人」「企業の研修担当の人」にも有益な資料になっています。 この記事の主な対象者 有名企業の研修資料を網羅的に知りたい人 エンジニア初級から中級者の人 独学で学習をしている人 研修思慮の作成担当 MIXI新卒研修2024 まずはじめに紹介するのは、毎年新人向けの研修

「ソフトウェアの「詳細設計書」とはなんなのか」というブログ記事を読んで考えたこと。設計に関するプロセスとドキュメンテーションの関係性についての考えの整理。SI屋的な視点で。 2024/8/18追記：文中にあった雑な文系disが不愉快というご指摘を受けました。ご指摘の通りだと思いましたので訂正しています。大変失礼しました。 「詳細設計書」とはなんなのか nowokay.hatenablog.com こちらの記事では詳細設計書とは以下のようなものであると整理されている。 表現を変えたコーディング（の一種） 机上プロトタイプ（の一種） 分析資料 保守（のための）資料 （水平作業の場合の）作業指示書 （委託している場合の）契約資料 上記以外で考えられるのは次のようなものがあるだろう 利害関係者が要求している たとえば受託開発において発注者が要求している場合 ほかには連携している相手先システム側から

【追記】この記事をきっかけに、名著「ノンデザイナーズ・デザインブック」の20周年記念特典eBookの制作に協力させていただきました。詳しくはこちらを御覧ください。 ノンデザイナーズ・デザインブック20周年記念の特典に寄稿しました デザイナーである・なしに関わらず、仕事の中で伝えたいことを「図」で説明する機会は多々あります。提案書で事業内容を説明することもあるでしょうし、具体的な数値をグラフで説明することもあるでしょう。そんな中でこんな指摘を受けたことはありませんか？ ・最終的に何を言いたいのか結論が見えないよ。 ・関係性が複雑すぎて理解しずらいんだけど。 ・要素が多すぎて全てを把握するのが大変。 ・何をどこから見れば良いの？ ・結局一番言いたいことはなんなの？ ・文字サイズがたくさんありすぎてまとまりがないね。 ・安っぽいチラシみたいでダサイなぁ。 ・全体的にバランスが偏ってて不安定。 ・

VSCode 設定抜粋以下のような設定を入れています。 { "markdown.preview.fontSize": 12, "markdown.preview.lineHeight": 1.4, "markdown.preview.breaks": true, "markdown.extension.orderedList.marker": "one", "markdown.extension.orderedList.autoRenumber": false, "markdownlint.run": "onType", "markdownlint.config": { "MD010": false, // タブでのインデントを許可する "MD024": false, // 複数の見出しで同じ文言を書くことを許可する "MD033": false, // HTML を使用することを許可する

はじめにTIG真野です。 秋のブログ週間2023 の3本目は、設計ドキュメントをGit管理して腐らせないようにがんばってみた話をします。 前段として6年前、「我々はいかにシステム開発におけるドキュメント腐る問題と戦えば良いのか」という記事を書いたのですが、その後の試行錯誤はどこにも残していないことに気づきました。普段のフューチャー技術ブログですとちょっと引け目を感じるテーマですが、秋の夜長を楽しむため読み物成分を多めに書くというテーマのこのブログリレーにピッタリな気がするため、この機会をお借りします。 ドキュメントも色々な種別があるかと思いますが、この記事では設計ドキュメントを指すことにします。設計ドキュメントは開発メンバーが参照するもので、ステークホルダーへの説明資料に引用して使うことはあれど、主目的は異なるという前提です。Design Docの場合もありますし、システム構成図、ERD、

DB設計の管理や作成に疲弊してません？こんにちは。ukmshiです。今日はDB設計の共有と管理に便利なツール、dbdocsについてお話しします。dbdocsを使えば、設計の可視化や共有がめちゃくちゃ簡単になるんです。今回は、その魅力と利点、そして実際の使い方について詳しく説明します。 dbdocsとは？ dbdocsは、コードベース（DBML）でDB設計を管理し、URLで共有することが可能なツールです。データベースのテーブル構造や関係性を可視化し、それを他のチームメンバーやステークホルダーと手軽に共有することができます。 DBMLについてはこちらを参考に dbdocsの利点 dbdocsの利点について詳しく見ていきましょう。 無料 まず最初に、dbdocsは基本無料です。コストを気にせずに利用できるので、チームの誰もがアクセス可能です。 コードベースで管理 dbdocsはコードベースでDB

毎回1つのテーマに絞り、テーマに対してのLTを行うTechDLT。「プロジェクトマネジメント・プロダクトマネジメント」をテーマにした「プロジェクト/プロダクトマネジメントについてLT！ TechDLT Vol.7」に登壇したのはJAXA宇宙科学研究所の三浦氏。まずは、ロケット打ち上げにおけるプロジェクトマネジメントの大きな方針について話します。 世の中の「プロジェクトマネジメント」などの言葉の源流は「NASA式プロジェクトマネジメント」である三浦政司氏：最初は「NASA式プロジェクトマネジメント」をちゃんと自分で勉強して体系的に紹介できたらとチラッと考えていました。でもそこまでいけなさそうだったので「NASA式プロジェクトマネジメント」に基づいた、私自身がJAXAでしている組織マネジメントについて、かいつまんで紹介できたらと思っています。 基本的にJAXAのプロジェクトマネジメントは、NA

2023.03.28 スキル 岩瀬義昌プロダクト 誰にでも分かりやすく、信頼できるドキュメントの存在は、プロダクト開発を円滑に進める上で不可欠だ。 2023年3月11日に発売された書籍『エンジニアのためのドキュメントライティング』（日本能率協会マネジメントセンター）を翻訳し、自身もエンジニアとしてさまざまな開発ドキュメントに触れてきた岩瀬義昌さんは、「プロダクトが育つ開発組織には、優れたドキュメントとドキュメントを尊重する文化がある」と話す。 では、プロダクト開発を成功に導く「優れたドキュメント」とはどのようなものなのか。また、そんなドキュメントが存在する組織は、そうでない組織とどんな差が生まれるのか。岩瀬さんに話を聞いた。 書籍『エンジニアのためのドキュメントライティング』翻訳者 人気ポッドキャスト『#fukabori.fm』運営者 岩瀬義昌さん（@iwashi86） 東京大学大学院修士

ドキュメンタリアンとは、役職に関係なく、ソフトウェア業界でドキュメントとコミュニケーションに関心を持つ人のことです。 www.writethedocs.org はじめに これは主に『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の書評です。私はSreakeにてSREという役職についています。SREはサービス概要、アーキテクチャの解説や図、各種構成図、各種手順書、ポストモーテム、ポリシー、SLA(SLO) … その他の様々な場面でドキュメントを書く必要があります。しかし、ドキュメントは価値が見えにくく時間と労力がかかり品質担保の面で重要度がとても高いのにその場での価値が見えにくいので浸透しにくいです。そのため、エンジニアとしてモチベーションが保ちづらいです。2021年 State of DevOps 2021 にもドキュメントに関する言及があり今後、

じゅじゅ @jujulife7 完全無料で学べる有名企業のエンジニア研修資料（最新版）をまとめました。 エンジニアの方にお勧めなのは勿論ですが、総合職・デザイナー職がエンジニアと円滑にコミュニケーションとるための基礎知識が求められる時代かと思うので、文系職の方も是非保存して勉強みてください。 pic.twitter.com/sDek1U43q5 2022-07-21 22:50:52

平成30年3月30日 政府は、世界最先端IT国家創造宣言(平成25年6月14日閣議決定)等に基づき、サービス・業務改革並びにこれらに伴う政府情報システムの整備及び管理について、その手続・手順に関する基本的な方針及び事項並びに政府内の各組織の役割等を定める体系的な政府共通ルールとして「デジタル・ガバメント推進標準ガイドライン」(平成30年3月30日各府省情報化統括責任者(CIO）連絡会議決定。以下「標準ガイドライン」という。）を策定しました。また、標準ガイドラインの内容を解説する「政府情報システムの整備及び管理に関する標準ガイドライン実務手引書」（以下「実務手引書」という。）を作成しています。

前回の記事「プロジェクト・コミュニケーションのベーシック　～　情報のトレーサビリティを確立する」で、英語で言うCommunication Managementとは、日本語的感覚でいう「コミュニケーションの管理」ではなく、むしろ『情報伝達のマネジメント』に近い、と書いた。だから、伝達のトレーサビリティ確保が大事になる、と。 今回はその続きである。だがもう一歩進んだあり方として、「ドキュメントのインデックス化」の話をしたいと思う。ドキュメントのインデックスとは何か？　簡単だ。それはプロジェクトが作成する文書・図面類をリスト化して、多少の属性を付加したものである。「ドキュメント・リスト」と呼ばれる場合もある。 なあんだ、そんなのならいつでも作ってるよ。そういって、ドキュメントが保存されているサーバのプロジェクト・フォルダから、ファイルのリストを印字して持ってくる人がいる。ファイル名の他に、作成日

先に前提を話しておくと、会社は全く辞めるつもりはないし、むしろどんどん会社を良くしていこうと思っている。今回はそういう基準で自分がコードやドキュメントを書いていますよという話。 コードやドキュメントを書く時に、どのくらいきれいにしておくかとか、どのくらいわかりやすくしておくかとかを考えることがある。こんなとき僕は、いつ突然自分が会社をやめて連絡がつかなくなったとしても他の人がある程度理解できるか、を基準にしている。そのためにはあまりいい方法が思いつかなくて仕方なく書いている部分にはちゃんと経緯のコメントを書く。他にも例えば作ったサービスであるイベントを開催する方法のドキュメントを書くなら、全く何もやったことがない人がそのドキュメントを読んだらとりあえず開催できるよう、ドキュメントを書く。当然コードもかっこよさよりも、説明しなくても分かりやすくなるようなシンプルさを追求する。 また、このよう

2023 追記 2023 年現在では、以下の文章では採用を見送っている OpenAPI を使えば OK という雰囲気です。 Web APIの設計 作者:Arnaud Lauret翔泳社Amazon TL; DR ドキュメント生成にはkevinrenskers/raml2htmlを使った ドキュメントはRAML - RESTful API modeling languageで書いた RAMLにはJSON SchemaとJSONを記載できる APIで返ってくるJSONはRailsアプリのrequest specでJSON Schemaを使ってテストした JSON Schemaはr7kamura/json_worldで生成した ドキュメントに載せる例示のJSONもJSON Schemaからgin0606/screijiを使って生成した 上記の方法だとリクエストパラメタとドキュメントの整合性を担保

背景 APIドキュメントを書くのが楽になるツールまとめ - Qiita iodocsで便利なREST APIドキュメントを作成する - Qiita これまでずっとREST APIドキュメントをwiki上で管理していて、重たいページ上で特殊記法使ったり、スタイルの調整に時間を取られるのが辛かった。そこで良さげなドキュメントツールを色々調べてたんだけど、最終的にapiary.ioが一番良さそうという結論になってきた。 このサービスの主な特徴。 markdown記法でAPIドキュメントを記述できる ドキュメントの生成と同時にAPIのモックサーバを用意してくれる サインアップから5分くらいあればドキュメント公開できる。ドキュメントのホスト先を気にしなくてもいい。 特にドキュメントと一緒にモックを作ってくれるのは他にはないポイントでかなり便利。 使ってみる サインアップはGithubアカウントで h

娘が保育園を卒園した。 ０歳児から６年間預けた。子どもは一人しかいないので、おそらくこれで保育園とはおさらばだろう。 保護者会の会長を最後の１年間つとめた。 園の存続が大問題になり、ぼくとしてはこれに明け暮れた１年だった。いったい保育園が消えてなくなるかもしれない、という事態なのに、「保育の向上」を組織目的にかかげる保護者会が何もしなくてどうする、というのがぼくの思いだった。 今はまだ詳しく書けないが、かなりのことができたと思う。しかもそれはぼくにしかできないことでもあった。支えてくれる人がたくさんいて、心底うれしかった。 組織体としてもPTA的形骸化が進みつつあった中で、久しぶりに自主的な運動の息吹をとりもどしたと感じた。 この運動の中で感じたことは、「文書にして意思を示す」ということの大事さだった。特に、お役所との関係では、決定的である。 地域（地元の町内会のようなもの）に要請というか

さいきんREST APIのドキュメントを書いていて、wiki使うのだるいし他に良い方法ないかな〜と調べてた時に見つけたツール群をまとめてみます。 追記: こちらも便利そうなので参考にどうぞ。 REST APIドキュメント作成ツールはapiary.ioが決定版かもしれない - Qiita swagger Swagger: A simple, open standard for describing REST APIs with JSON | Reverb for Developers デモ: Swagger UI ソースコード中にAPIの概要を書いておくと、それを元にドキュメントを自動生成してくれる。wikiやmarkdownで書くのと決定的な違いは、↓のようにドキュメント上のformからAPIコールを試すことができる点。 様々な言語のWAFに対応したライブラリも開発されてる。 Home ·

Build a website. Sell your stuff. Write a blog. And so much more.