ドキュメンテーション

皆さん、こんにちは！もしくはこんばんは！ 楽楽精算プロダクトマネージャーの@wekkyyyyです。 前回は「楽楽精算のPRD(製品要求仕様書) Agenda」というテーマで記事をかかせていただきました。 tech-blog.rakus.co.jp 今回は趣向を変えて、「資料を作るときに考えていること」 いわゆるドキュメンテーションスキルについて書いていこうと思います。 目次は以下となります。 対象読者 筆者がどんな人物か なぜこれを書いたのか 注意点 資料を作るときに考えていること 【まずやる】仕事と作業を分けて優先度をつける 【いざ開始】1つのアウトプットを3ステップで分けて作業する 【15…

こんにちは、トモニテ開発部の Android エンジニアです。 この記事は every Tech Blog Advent Calendar 2023 の 5 日目です。 最近、 Android エンジニアに新たなメンバが増えました。 こんなこともあろうかと作っておいた贈り物としてドキュメントがありますので、どんなものか紹介します。 どんなドキュメントなのか GitHub にあるプロダクトのリポジトリの Wiki に、 アプリの構成 開発の前に 開発時の Q&A File Templates をまとめたものです。 アプリがどんな作りなのか？ 開発するにあたり守るべきことはあるか？ xxx をやり…

最近あるサービスのスマートフォンアプリに新機能を追加している。 そのアプリではAndroidネイティブ、iOSネイティブ、WebView、React Nativeの4種類の画面から構成されている。APIはREST APIとGraphQL APIの2種類がある。一見するとどこでどの技術を使っているのかわからないので、仕様を決めるためのコミュニケーションで誤解を生んだり、何度も同じ確認をするコストがかかっている。 この問題をどうしたら解決できるのだろうか。 根本的には APIの統合や、React Native を採用をやめてシンプルな構成にするというような採用技術の見直しとリファクタリングが必要だ…

はじめに こんにちは、ホワイトプラスのコアシステム開発グループでエンジニアリングマネジャー（EM）をしているinouehiです。 私はエンジニアの仕事の中で重要な位置を占めるコミュニケーションに興味を持っています。今回はその中でも、ドキュメントによるコミュニケーション、特に文章に注目したいと思います。 よいドキュメントと悪いドキュメント ドキュメントとは、誰かの頭の中にある暗黙知を見える化して他者への共有を可能にする仕組みと私は捉えています。これにより、ナレッジの拡散をある程度自動化したり、業務の属人化を軽減する等の効果が期待できます。うまく作られたドキュメントからは、かける手間に対して大きな…

10月からコンサルタントに出戻りしたエンジニアです. 入社前に想定していた以上に毎日が楽しいです*1. それはさておき, つい先日に前職の同僚であるエンジニアリングマネージャーの@jazzsasoriさんとサシ飲みしたのですが, 「エンジニアリングマネージャーとかテックリードとかになると, 議事録（的なメモ）」を取る力無いと辛いよね, 案外言及されてないけど という話題になりました, 酔っ払ってあんまり覚えてないけど🍻*2 で, どれぐらいの方がこの話題に興味あるのかな?と気になり, 昨夜、久々に前職エンジニアリングマネージャー氏と飲んでて、何かの拍子に「エンジニアがビジネスな力をつける訓練の…

見出しを5W1Hにするとわかりやすいドキュメントがかけそう。読む人の知りたいことを言語化するとなぜ・なに・なんのためのような形になると思うで読む人にとっては負荷が低くなりそう。 見出しがWhat, How, Whyの例 https://simperium.com/overview/ あと、例を書くときに目立つようにDO / DON'T をつけるとわかりやすい。「何々をしてください」 「何々をしないでください」 と書かれるとちゃんと読まないと反対の意味に取ってしまう。 やる・やらないを目立つように書いて、さらに色や記号で使っていると一瞬でわかってありがたい。 わかりやすいDO / DON'Tの例…

エンジニアの辛い仕事を消す本かも（多分） 2014年の秋にリクルートに転職してから何社か経て今も自社サービスのエンジニアとして働いてるマンです. リクルートに入ったとき, そしてその後の転職先*1などなどで, 社内外問わずのコミュニケーションの辛さ. 社内調整, 顧客折衝etc... コードじゃなくて, ドキュメントを書く仕事の辛さ. プレゼンテーション・説明そのもの. 技術わかんない上司に説明(ry*2 みたいな経験をたくさんしました&これはエンジニアをやってたら誰でも直面する事態かなと思います, 自社サービス企業だろうがSIer/受託開発の企業だろうが. そもそも, 昔の調査にもそんな雰囲…

この記事では、JMPの最新バージョン「JMP 18」で、ヘルプの役割を果たすドキュメンテーションをPDF形式で表示する方法をご紹介します。

ドキュメンテーションジェネレーターの説明として，適切なものはどれか。 HTML，CSSなどのリソースを読み込んで，画面などに描画又は表示するソフトウェア ソースコード中にある，フォーマットに従って記述されたコメント文などから，プログラムのドキュメントを生成するソフトウェア 動的にWebページを生成するために，文書のテンプレートと埋込み入力データを合成して出力するソフトウェア 文書構造がマーク付けされたテキストファイルを読み込んで，印刷可能なドキュメントを組版するソフトウェア 解答・解説 (adsbygoogle = window.adsbygoogle || []).push({}); 解答 …

著者：小林 昌樹［こばやし・まさき］(1967-) 司書。レファレンス論、図書館史、近代出版史、読書史。 件名：情報活動（インターネット） 件名：レファレンスワーク NDLC：UA21 NDC：002.7 総記 >> 知識．学問．学術 >> 研究法．調査法 NDC：007.58 総記 >> 情報科学 >> ドキュメンテーション．情報管理 >> 情報検索．機械検索 備考：メールマガジンでの連載を書籍化したもの。https://www.libro-koseisha.co.jp/webcolumn_category/mail-reference-tips/ 調べる技術――国会図書館秘伝のレファレンス…

今回は、「Flutterを最近始めたよ！」という方や「Flutterとはそもそも何？」という方に向けて概要を簡潔にまとめてみました。これを読めば明日からFlutterについて語れます。笑 この記事で分かること ✅Flutterの概要 目次 はじめに：Flutterとは Flutterの歴史と開発 Flutterの主な特徴 Dart言語との関連性 Flutterの基本的な概念 Widgetsとは Stateとは Flutterの利点 クロスプラットフォーム開発の利点 高性能なUIの構築 豊富なパッケージエコシステム Flutterの成功事例 Flutterを学ぶための方法 まとめ：Flutter…

CTO 室の恩田です。 今回は GitHub Copilot Enterprise を評価してみて、現時点ではまだ採用しないことを決めた、というお話をご紹介したいと思います。 きっかけ とあるエンジニアが Slack で自身の times チャネルに時雨堂さんの GitHub Copilot Enterprise のススメという記事を投稿したことが発端でした。特に感想はなく URL に 👀 だけが添えられていたので、後で見るぐらいのメモだったんだと思います。 それを見かけた別のエンジニアが技術雑談チャネルにその投稿を共有して、これは凄そうと話題を向けたところ、CTO の「評価してみる？」の一言…

今回はScott Berkun氏の「アート・オブ・プロジェクトマネジメント」を要約していきます。マイクロソフト社で多くのプロジェクトマネジメントを成功に導いてきた氏の経験に裏打ちされたプロジェクトマネジメントにおける急所を体系的にまとめた本です。本書は三部構成となっており、Ⅰ部はプロジェクトマネジメントにおける計画・Ⅱ部はプロジェクトマネジメントを行うに必要なスキル・Ⅲ部はマネジメントの技法を解説しております。今回はⅠ部の計画部分の要約を行います。 「アート・オブ・プロジェクトマネジメント」 ■ジャンル：開発管理 ■読破難易度：中（主にソフトウェア関連のプロジェクトワークを想定していますが、サ…

こんにちは。 本日は、Pythonメモです。 定義方法 docstring クラス変数 インスタンス変数 メソッド 定義方法 一番シンプルな定義は以下です。 以下は、中身のないクラスを定義しています。 class MyClass(): pass インスタンス化は、クラス名()とします。 m = MyClass() docstring クラスのdocstring(ドキュメンテーション文字列)は以下のように記載します。 class MyClass(): """Sample Class""" pass docstringを取得するには、__doc__を使用します。 m = MyClass() pri…

Django REST Framework(以降DRF)は、人気のDjangoウェブフレームワークを拡張したライブラリで、RESTful APIの開発を大幅に効率化してくれます。DRFは、APIの作成、認証、ドキュメンテーションなどの機能を包括的にサポートしており、開発者の生産性を飛躍的に高めてくれます。今回は、DRFの魅力的な機能と実践的な使い方について詳しく解説していきます。 DRFのインストールと設定 Serializerの定義 ビューの定義 高度な機能 認証と権限管理 ドキュメンテーション その他の機能 DRFのインストールと設定 DRFを使ってRESTful APIを構築するには、ま…

エピックストアのUE5マーケットプレイスで買えるオススメ有料アセット&無料アセット(テンプレート)を、ゲームカテゴリ別に紹介していくぜ！ 2024年4月18日まで「春のクリエイターセール」が開催中！！欲しいアセットを見つけたら忘れずに買っておこう。 商品ページやデモ動画を見て質が良さそうなアセットを抜粋した記事だから、UE5上での実際の動作は未確認だ。「見映えだけは良いがカスタマイズ性に欠けるアセット」という可能性もある。自分でよく商品ページを見たうえで購入するかどうか判断してね…！ ①ドキュメンテーション(説明書)が購入前から公開されている＋②レビュー文にDiscord名の記載が無い＋③レビ…

はじめまして、TalentX, EMの岸本です。 TalentXでは開発業務の他、バックエンドチームのマネジメントを担当しています。 昨今のAPI開発において、OpenAPIを用いた仕様の定義は一般化していると思いますが、 その運用方法に関して、TalentXで工夫している点などを踏まえてご紹介させていただきます。 スプレッドシートからの脱却 私が入社した数年前のタイミングでは、APIの仕様はスプレッドシートで管理されていました。 その際の課題として バージョン管理が難しく、適切なロールバックや変更タイミングの把握ができない。 Slack等でのコミュニケーションになってしまう、変更場所の把握が…

はじめに エンジニアとして就職する前に読んだ「なれる!SE 2週間でわかる?SE入門」の内容があまりにも厳しく、業界に就職するのが怖くなったことを覚えています。本の中に登場する中学生の少女にしか見えない凄腕のSE、室見立華さんのような人物は現実には存在しないでしょうが、実際の業界には彼女のような凄腕エンジニアや年齢不相応な技術力を持つ人間も確かに存在します。 なれる！SE ２週間でわかる？ＳＥ入門 (電撃文庫)作者:夏海 公司,IxyKADOKAWAAmazon SREの探求『Becoming SRE』の内容紹介 私は「なれる!SE」が好きすぎるあまり、「なれる!SRE」というタイトルのクソみ…

2017年に以下の記事を書いていました。最近も時々この記事が引用されたりX (Twitter) でもいまだにシェアされたりしているのを観測しています。 blog.stenyan.jpなおこれはもはや7年前の記事で、ベースの考えは大きくは変わっていないものの、普通に自分用のチャンネルをいまは作っています。 運用次第で良し悪しある まず結論としては、チャンネルを作ったほうが良いとか作ってはいけないということよりも、使われ方（運用）方法次第で上手く回らない可能性があるよねという話だと思っている。なので、Xなどでtimes不要論が流れてきても「結局どう運用しているか次第だな〜」とニュートラルよりな気持…