GitLab に学ぶ パフォーマンスを最大化させるドキュメンテーション技術 数千ページにもわたるハンドブックを活用したテキストコミュニケーションの作法
なぜ注目されているか
総合65位 ✦ NEW 言及 1 件
言及した記事 (1 件)
この本に興味がある方におすすめ
関連する本
関連記事
技術書と公式ドキュメントの使い分け - それぞれの強みを活かす
技術書と公式ドキュメントの役割の違いを明確にし、学習段階に応じた最適な使い分け方を紹介します。
学習法公式ドキュメント
データベース本ガイド - SQL から設計まで学べる技術書の選び方
データベースの基礎から設計、パフォーマンスチューニングまで学べる技術書の選び方と学習順序を紹介します。
データベース選書ガイド
README を書くように本を読む - エンジニアのための構造化読書法
エンジニアが日常的に書く README のフォーマットを読書に応用する方法を紹介します。目的 / 使い方 / 注意点の 3 点で本の内容を整理すると、半年後に読み返しても実務で引き直せる記録として残ります。
読書術アウトプット
関連用語
API ドキュメントとは - 仕様 / エンドポイント / 入出力形式を記述し開発者の統合を支援する文書
API の仕様、エンドポイント、リクエスト/レスポンス形式を記述し、開発者の統合を支援するドキュメント
Conventional Commits とは - コミットメッセージ規約の書き方と導入手順
Conventional Commits はコミットメッセージに feat/fix 等の型を付与する規約。CHANGELOG 自動生成やセマンティックバージョニングとの連携方法を実例で解説
境界づけられたコンテキスト
ドメインモデルが一貫した意味を持つ範囲を明確に区切り、モデルの曖昧さを排除する DDD の戦略的パターン
フォーマッター
ソースコードのスタイル (インデント、改行、スペース) を自動的に統一するツール
Markdown
プレーンテキストで記述し、HTML に変換できる軽量マークアップ言語
LaTeX
数式や論文を美しく組版できる文書作成システム。学術分野で広く使われる