ymmt2005

技術文書の書き方

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

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

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

amatsuda

tl;dr

高円寺の南のほうのあたりで、ちょっとした新築共同住宅プロジェクトを立ち上げてみたいと思っています。つきましては、このプロジェクトの趣旨とノリに賛同してくださって居住してくださる方をふわっと募集します。

My New Gear...

最近、高円寺の南のほうのあたりに築古賃貸物件を買ってみました。物件概要はざっくり以下のような感じです。

• 立地: 丸の内線東高円寺駅徒歩5分、JR中央線中野駅徒歩12分(Google調べ)
• 地積: 110平米と120平米の間ぐらい
• 建物: 築およそ30年の2階建て木造アパートを賃貸運用中

この建物には問題がある！

LeopoldTal

/*
 * Mandelbrot set ascii art
 */

#include <stdio.h>
#include <string.h>

/* Params */
//TODO: these should be command line arguments

Lense

randomware

SECCON 2016 quals

description

300 points
My PC suddenly got broken. Could you help me to recover it please?
NOTE: The disk can be virus-infected. DO NOT RUN any programs extracted from the disk outside of sandbox.
disk.qcow2.zip
Challenge files is huge, please download it first. Password will release after 60min.
password: h9nn4c2955kik9qti9xphuxti

oskimura

Erlangでオレオレ言語の作り方

言語実装 Advent Calendar 2015の22日目として書かれました。 ErlangでBEAMで動くコンパイラする作成を説明します。

ulangというサンプルプログラムを作ったのでこれを元に説明します。 https://github.com/oskimura/ulang.git

主な流れとしては字句解析器、構文解析器を行って中間表現に変換しcompileモジュールを使ってBEAMで実行可能なバイナリを作成するという流れです。 今回はulang.xrlで字句解析を行い、ulang_yecc.yrlで構文解析及び中間表現の出力、compiler.erlでバイナリ出力するようにつくりました。

gakuzzzz

Scala の省略ルール早覚え

このルールさえ押さえておけば、読んでいるコードが省略記法を使っていてもほぼ読めるようになります。

メソッド定義

def concatAsString(a: Int, b: Int): String = {
  val a_ = a.toString();
  val b_ = b.toString();

uehaj

/**
 * Hindley-Milner type inference
 * Ported to Groovy from Scala by Example Chapter 16 code.
 * (http://www.scala-lang.org/docu/files/ScalaByExample.pdf)
 * refered also
 * https://github.com/namin/spots/blob/master/hindleyMilner/typeInference.scala
 * Japanese page of 'Scala by Example':
 * http://www29.atwiki.jp/tmiya/pages/78.html
 */
import groovy.transform.*

edokeh

//
//                       _oo0oo_
//                      o8888888o
//                      88" . "88
//                      (| -_- |)
//                      0\  =  /0
//                    ___/`---'\___
//                  .' \\|     |// '.
//                 / \\|||  :  |||// \
//                / _||||| -:- |||||- \

rummelonp

ChangeLog を支える英語

ChangeLog を書く際によく使われる英語をまとめました。

ほとんど引用です。

基本形

voluntas

マイルストーン > タスク > チケット

マイルストーンはマスタースケジュール、これをタスクに分割する。
マイルストーンの名前でリリース用のブランチが自動的に作成される。
マイルストーンを完了するとマイルストーンの名前で自動的にtagが作成される。


タスクは個人の作業単位、最小のタスクは最大でも1週間程度で終わる先の見える見積もり可能な大きさの作業になる。
要件を具体的な作業単位に落とす中間的なタスクが存在する。つまり、タスクはタスク間の関連性をN:Mマッピング出来る。