タグ「ドキュメンテーション」

タグドキュメンテーション

新着順人気順 5 users 10 users 50 users 100 users 500 users 1000 users

(1 - 25 / 32件)

ドキュメントとしての詳細設計書と、プロセスとしての詳細設計 - 勘と経験と読経

2024/08/17 254 users 読経ドキュメントプロセスソフトウェア詳細設計

「ソフトウェアの「詳細設計書」とはなんなのか」というブログ記事を読んで考えたこと。設計に関するプロセスとドキュメンテーションの関係性についての考えの整理。SI屋的な視点で。 2024/8/18追記：文中にあった雑な文系disが不愉快というご指摘を受けました。ご指摘の通りだと思いましたので訂正しています。大変失礼... 続きを読む

ドキュメンテーションを文化にする〜コミュニケーションの「ハブ」作りに取り組んだ4年間～ - MonotaRO Tech Blog

2024/07/31 222 users ハブコミュニケーション文化 4年間

はじめにこんにちは。プラットフォームエンジニアリング部門の池田（@progrhyme）です。この記事では、モノタロウのテック系の部門で筆者が取り組んできた「ドキュメンテーションプロジェクト」について、下の目次の流れに沿って紹介していきます。【目次】はじめに「ドキュメンテーションプロジェクト」とはプロ... 続きを読む

ウィキについて - GitHub Docs

2024/07/15 46 users ウィキ GitHub Docs GitHub リポジトリ他者

リポジトリのドキュメンテーションをウィキでホストして、他者が利用してプロジェクトにコントリビュートすることを可能にできます。 Wikiは、組織の場合はGitHub FreeとGitHub Freeのパブリック・リポジトリで、パブリックおよびプライベート・リポジトリではGitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub... 続きを読む

Vitestでドキュメンテーションテストする

2023/09/13 19 users Vitest

ドキュメンテーションテストをご存知でしょうか。ドキュメンテーションテストとは、ドキュメントに記載されたコードを実行し、その結果が期待通りであるかを検証するテストのことです。これにより、ドキュメントの内容が常に最新の状態であることを保証することができます。 Rustでは公式がrustdocというツールを提供... 続きを読む

【汎用ソフトスキル】ドキュメンテーションの続け方

2022/03/29 227 users 続け方

この記事の目的最近「良いドキュメントが作れているな」と思う機会が増えてきたので、その知見をアウトプットしたくなった。想定読者今所属してる組織(会社/プロジェクトなど)のドキュメントがイマイチで悩んでいる人そもそもドキュメントが無い組織に所属していてつらい思いをしている人「ドキュメントを作れ」と... 続きを読む

継続的ドキュメンテーション: Github DiscussionsとADRのすすめ - LIFULL Creators Blog

2021/09/11 137 users ADR GitHub Discussions

こんにちは。テクノロジー本部のyoshikawaです。好きなW3C Recommendation は RDF 1.1 Concepts and Abstract Syntax です。会議やチャットでのやり取りの決定事項・議事録、アプリケーションや機能の設計書・仕様書、READMEなどなど... LIFULLの開発現場においては、ソースコード以外にもこのように様々な文書の管理・... 続きを読む

プログラマーがドキュメントを書かない理由 - ITnews

2021/06/03 495 users ITnews medium トキプログラマードキュメント

この記事は、著者の許可を得て配信しています。 Why programmers don’t write documentation 最近ではずっとコードのドキュメンテーションに関連した記事を書いていたので、当然、私のMediumのおすすめ記事には「開発者がドキュメントを書かない本当の理由」という記事が表示されるようになりました。この記事では、ドキ... 続きを読む

ピクシブでのNotionのつかいかた - pixiv inside

2021/05/20 20 users Notion ピクシブ GETA pixiv inside

こんにちは、pixivのリクエスト機能を開発するチーム（以下、リクエストチーム）でプロダクトマネージャーをしているgeta6です。ピクシブでは、社内ドキュメンテーションツールとしてNotionを採用しています。Notionでうまいことドキュメンテーションが機能し、継続できるよう、使い方やルールを各メンバー・各チームみ... 続きを読む

社内のドキュメンテーションの取り組みと、Kitenのご紹介 - ペパボテックブログ

2021/03/18 11 users ペパボ june29 ペパボテックブログ休日人々

はじめに技術部の @june29 と申します。最近の趣味は「お散歩」で、よく晴れた休日には妻といっしょに2時間くらい歩き回ったりしています。この記事では、わたしが2020年から力を入れて取り組んでいる社内におけるドキュメンテーションの活動の一部を紹介したいと思います。問題意識もともと、ペパボで働く人々には「... 続きを読む

リモートワークのいま学びたい、GitLab Handbookと徹底した文書化への狂気 - Qiita

2021/03/01 259 users Qiita Problem リモートワーク GitLab 狂気

Help us understand the problem. What is going on with this article? 1200人以上の全社員がリモートワーク。GitLabが公開する「リモートワークマニフェスト」は何を教えているか？スケールする組織を支えるドキュメンテーションの技術を”GitLab Handbook”から学ぶそのコメント GitLab Handbookで面白かったもの@コ... 続きを読む

GoogleやMicrosoftなどIT大手連合が「Open Web Docs」を発表 - GIGAZINE

2021/01/26 12 users GIGAZINE 下火 Mozilla Microsoft

GoogleやMicrosoftらで構成される大手IT企業連合が2021年1月26日に、Web開発者向のオープンなドキュメンテーションを支援するプロジェクト「Open Web Docs」の設立を発表しました。Mozillaも参加するこのプロジェクトは、Mozillaの不振により下火となっていたMDN Web Docsの空白を埋めるものになると期待されています。 ... 続きを読む

Oh Shit, Git!?!

2020/11/12 425 users Git ニワトリ oh shit 事柄ハマリ

Gitって難しい。簡単にぐちゃぐちゃの状態になっちゃうし、失敗を直す方法を知ろうとしたところでまじくそ不可能。Gitのドキュメンテーションって卵とニワトリの問題みたいなところがあって、ハマりから抜け出すために知ってないといけない事柄の名前をあらかじめ知っていないと、どうやって問題を解決したらいいのか検... 続きを読む

GitLab的ドキュメント文化を組織にインストールする（実践編:スタートアップMNTSQの事例）｜Anno Takahiro｜note

2020/03/27 29 users Anno Takahiro｜note ドキュメント文化

会社組織にドキュメント文化をインストールすることの有用性や、GitLabのような企業がどのようにドキュメントを運用しているかを、前回記事で書いた（スケールする組織を支えるドキュメンテーションの技術を”GitLab Handbook”から学ぶ）。今回は、私のいるスタートアップのMNTSQ（モンテスキュー、と読みます）でどのよ... 続きを読む

スケールする組織を支えるドキュメンテーションの技術を”GitLab Handbook”から学ぶ｜Anno Takahiro｜note

2020/02/14 265 users スゲー GitLab Handbook 口頭スケール組織

ドキュメント文化は健全な組織のスケールのために必要　組織の中でドキュメント/文章を残し活用していくことはとても重要だ。クオリティの高いドキュメントがあることで、組織に情報が流通し、透明性を確保できるようになる。情報を流通させるためにいちいち口頭の説明がいらないから、メンバーの数が増えた時でもスケー... 続きを読む

アメリカ空軍のドローンのドキュメンテーションがダークウェブで200ドルで売られていた | TechCrunch Japan

2018/07/12 13 users ダークウェブドローンアメリカ空軍 200ドル

クックパッドが食品ECビジネスに参入、街のお店の“こだわり食材”をアプリで買える「クックパッドマート」発表続きを読む

Googleが社内のドキュメンテーションスタイルガイドを公開 | TechCrunch Japan

2017/09/08 636 users TechCrunch JAPAN Google 社内公開

ドキュメンテーションは往々にして、後（あと）からの付け足しだ。オープンソースのプロジェクトではとくにそれが多い。そのため新しい人が後日そのプロジェクト参加しづらくなったり、ときにはヘタなドキュメンテーションのせいでコードがかえってわかりづらくなることもある。そこでGoogleは、デベロッパーがもっと良いドキュメンテーションを書けるために、同社の developer-documentation st... 続きを読む

2016/09/15 141 users angular バグ修正正式リリース後解説予定

どうも、らこです。ついに Angular 2.0.0が正式リリースされました！めでたい！！今回はRC.7も含めた変更点の解説に加えて、正式リリース後のAngularの予定についても紹介します。 RC.6からの変更点 RC.7、2.0.0ともに、ほとんどがバグ修正とドキュメンテーションの追加で、破壊的な変更はRC.7にひとつあるだけです。 2.0.0-RC.7 2.0.0 破壊的変更 ...M... 続きを読む

(1 - 25 / 32件)

次の25件 »