by shigemk2

当面は技術的なことしか書かない

2017-11-18から1日間の記事一覧

OSSドキュメンテーション勉強会に行って、LTした #kbkz_tech

ドワンゴ主催の、歌舞伎座.tech#14「OSSドキュメンテーション勉強会」に行ってきて、LTしました。 こちらは資料です。ひたすらドキュメントに貢献し続けた話をしました。 ドキュメントを直し続ける話 #kbkz_tech from Michihito Shigemura 以下、感想という…

memo 反面教師で学ぶ参考書の書き方 #kbkz_tech

https://ezoeryou.github.io/how-not-to-write-textbook/ @ezoeryou ソースファイルは分割しろ xhtmlが未来だった時代 でもそうならなかった 1MB以上あった手書きのXHTMLファイル Vimで開いてもなおしんどい ウェブブラウザ上で編集ができなくなった(ファイ…

memo READMEに何を書く? #kbkz_tech

ツッコミがあったらください 個人的にやっていること ライブラリがあったらpublishする publishする READMEを書こうとする 何を書こうか… 方針 個人でしか使わない想定 ライブラリ管理をpackage managerに任せたいという気持ち ドキュメントにコストをかけた…

memo 単語の揺らぎに対処するための手法と実装 #kbkz_tech

http://redpen.cc/ OSSプロジェクトのドキュメントを書くと 表記ゆれ に悩まされる ベトナム ヴェトナム(文字) Excel エクセル(文字種) 行う 行なう(送り仮名) RedPenではどうしているのか そもそもそんなにクリティカルじゃないけど、発見にコストがかかる …

memo C++リファレンスサイトcpprefjpでのドキュメンテーション #kbkz_tech

3000ページ 標準ライブラリのレファレンス C++14までは網羅 マイナーライブラリは保留 3年ごとにリリースしている 仕様が決まったらスケジュールとしても動かない GitHubで、markdown→HTML (めるぽん氏の)自前のサーバーでHTML変換 すべてボランティアでスポ…

memo Node.jsのドキュメント整備について(仮) #kbkz_tech

Node.jsはIssueなども日本語である程度対応している we/Iは使わない https://developers.google.com/style/pronouns#personal-pronouns CIはヨーロッパに置いてあるサーバーのJenkins Lintをかけて、convertできるかどうかテストする gitlocalize misspell …