タグ

ドキュメントに関するyfukuda827のブックマーク (5)

  • チームに無能がいなくなる『メンバー全員で公式ドキュメントを読みあわせる』に感銘をうけた話。 - Qiita

    Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? これは、同じエンジニアであるから聞いた話なのですが、彼女の案件で「メンバー全員で公式ドキュメントを読みあわせる」という取り組みがあったそうです。 で、この方法「チーム全体にとって大きなメリットがあるんじゃないか?」と思ったので、共有させていただきます。 「誰も知らない」から「みんな知ってる」に 私は開発職なので、めずらしいことなのかそうではないのか判断がつかないのですが、その案件では、導入対象の製品について詳しい知識を持っているメンバーが一人もいなかったというのです。 誰もその製品をさわったことがなく、とりあえず強そうなメンバーを入れ

    チームに無能がいなくなる『メンバー全員で公式ドキュメントを読みあわせる』に感銘をうけた話。 - Qiita
    yfukuda827
    yfukuda827 2024/10/21
    技術書の輪読会とかいいよって聞くけど、知識差を無くすって意味合いで、公式ドキュメントもいいのかーなるほどね。今度中学生にプロフラミング教える時にみんなで読んでみよう😊
  • ドキュメントや意思決定資料の作成方針 | ツチノコテックアカデミア

    ツ社ではGitHubを利用してソースコード管理を行っています。 ドキュメントや意思決定の資料についてもGitHubでできるだけ管理したいと思いますので、以下を基準に作成をお願いします。 Architectural Decision Records (ADRs) アーキテクチャをどうやって決めていったのかの履歴を、ADRとして記録していきます。 各リポジトリの /docs/adr フォルダに格納していきます。 テンプレートを /docs/adr/tpl/ADR.md で用意していますので、コピーして使ってください。 ADRを作っていくことで、担当者が変わった時や、みんなが忘れたころに、「これってどうやって決めたっけ?」を思い出せるようにしていきます。 ツ社は、チャットツールを原則禁止しているので、GitHubのissueやDiscussionにメモがあるかもしれませんが、きちんとした文書を残

    yfukuda827
    yfukuda827 2024/09/25
    書きました。ツチノコテクノロジー社員向け。
  • ググり時間をぶった切る。AWSを最速で攻略するサイト13選 - Qiita

    はじめに 自分がAWSをこれっぽっちも知らない頃、 ググって出てきたどこか知らんサイトからだと、「欲しい情報はこれじゃない」ってのが多くあった。 そんなこと繰り返していると エラー、トラブル時に即対応できない 間違って構築したせいで運用時に悪化してしまう 古いソースコードでエラーがでて動かない これで無駄な時間を過ごすことになる。 要は「ググって得たその情報で、作ったものは正しいのか?」 AWSは常にアップデートされ続ける 欲しい情報を手に入れるまで調べる時間を割くなら、 公式展開してるサイトから得たほうが正確である。 ということで、最速でAWSを攻略するサイトをまとめる。 この記事をブックマークでもしておくと、ググる手間も省けるだろう。 目次 AWSドキュメンテーション AWSサービス別資料 トレーニングライブラリ AWSブログ アーキテクチャーセンター ワークショップをする よくある質

    ググり時間をぶった切る。AWSを最速で攻略するサイト13選 - Qiita
    yfukuda827
    yfukuda827 2022/12/29
    AWSのドキュメントは読むのが3回目だとしても新しい発見があるんだよ
  • Furoku_CheatSheet_Vim_責

    300 Vim CHEAT SHEET ÌESCÔ ÌCtrlÔ

  • ドキュメントは最強のコミュニケーションツールである――Joelの機能仕様書入門

    Joelの機能仕様書とは 有名なソフトウェア技術ブログ『ジョエル・オン・ソフトウェア(Joel on Software)』の著者であり、元マイクロソフトのエンジニアであるジョエル・スポルスキ氏が紹介している仕様書の書き方が、Joelの機能仕様書です(スポルスキ氏人は、単に「機能仕様書(functional specifications)」と呼んでいます。ここでは、一般的な仕様書と区別するために、この名前を使っています)。 Joelの機能仕様書とは、ひと言で表すと「そのソフトウェアがどのように機能するのかを、ユーザー観点で読みやすくまとめたドキュメントであり、設計者とユーザー(顧客)が仕様を共有し、コミュニケーションするための道具となることを狙った仕様書」です。 Joelの機能仕様書の詳しい書き方は、氏の著書やWebサイト(有志による日語版)にも無償公開されていますが、最初に公開されてか

    ドキュメントは最強のコミュニケーションツールである――Joelの機能仕様書入門
    yfukuda827
    yfukuda827 2022/11/23
    機能仕様書、役割としては開発前の意思疎通と納品前のテストシナリオとして使うってことなんだと思ってる。ただ複雑な機能のシナリオ作成は、ただひたすら難しいんだよなーーー涙
  • 1