ymmt2005

技術文書の書き方

このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。

科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。

しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。

mpppk

2020/5/31追記: 自分用のメモに書いていたつもりだったのですが、たくさんのスターを頂けてとても嬉しいです。
と同時に、書きかけで中途半端な状態のドキュメントをご覧いただくことになっており、大変心苦しく思っています。

このドキュメントを完成させるために、今後以下のような更新を予定しています。

• TODO部分を埋める
• 書籍を基にした理論・原則パートと、実装例パートを分割
  • 現在は4層のレイヤそれぞれごとに原則の確認→実装時の課題リスト→実装例という構成ですが、同じリポジトリへの言及箇所がバラバラになってしまう問題がありました。更新後は、実装時の課題リストを全て洗い出した後にまとめて実装を確認する構成とする予定です。

2021/1/22追記:

tos-kamiya

(2020.01.11追記)

Pypy 7.3.0からインストール方法が大幅に変更されたので、公式の説明に従って、ディストリビューションに応じた方法に従うのを推奨します。

https://pypy.org/download.html

---

(2019.03.12更新)

gcchaan

エンジニア向け研修

• AI Shift
  • 社内SQL研修のために作った資料を公開します - (2021/06/21)
• CARTA HOLDINGS（旧VOYAGE GROUP）
  • 技術広報が新卒研修<Open AIハッカソン>をスパイしてみた - (2023/04/11)
  • @t_wadaに学ぶテスト駆動開発【CARTA 23新卒研修】 - (2023/04/19)
  • 【新卒研修】監修者@t_wadaと読む！プログラマが知るべき97のこと読書会 - (2024/04/09)
• Classi
  • 当たり前にリリースしていく ~ 新卒研修編 - (2021/05/20)
• リモートワークのための質問力向上研修を実施しました - (2021/12/07)

gurimusan

diffってなんだ

2つの要素に対して差分を求めるとは、何が変わっていないのか、何が追加されたのか、何が削除されたのか、求める行為である。

差分を計算するために、下記3つを計算する。

• 編集距離 (levenshtein distance)
• 2つの要素の差分を数値化したもの
• LCS (Longest Common Subsequence)
• 2つの要素 X と Y の最長共通部分列

morikuni

#!/bin/bash

echo platex "$TEXPAD_ROOTFILE"
platex "$TEXPAD_ROOTFILE"
echo pbibtex "$TEXPAD_ROOTFILE_NO_EXT"
pbibtex "$TEXPAD_ROOTFILE_NO_EXT"
echo platex "$TEXPAD_ROOTFILE"
platex "$TEXPAD_ROOTFILE"
echo platex "$TEXPAD_ROOTFILE"
platex "$TEXPAD_ROOTFILE"