タグ

documentationに関するtorazukaのブックマーク (5)

  • GitHub - braydie/HowToBeAProgrammer: A guide on how to be a Programmer - originally published by Robert L Read

    You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert

    GitHub - braydie/HowToBeAProgrammer: A guide on how to be a Programmer - originally published by Robert L Read
  • 技術系ブログを書いてくれてる人に申し上げたいこと6つ

    はじめにいつもお世話になってます! 助かってます! ありがとうございます! 解説サイトの人は特にありがとうございます! How to doは多いけど、Why I did in this wayで書かれてる記事が極端に少ないことたぶん備忘録として書いている人が多いと思うんだけど、マニュアルのような書き方が多い気がします。いやまあマニュアルがないよりは遥かに嬉しいことなんですが。重ね重ねいつもありがとうございます。 『AしてBしてCすると、コレができる! かんたん!』で終わっていることが多いです。多いというか、ほぼこれです。 『ほげほげのためにA、もげもげのためにB、FUBARのためにCすると、コレができる』というように書いてくれると相当嬉しいです!別に『これこれをクリックして…』とか『bashとはうんたらかんたら』とか詳細を書かなくてもいいので、こういう目的のためにやったと書いてくれると嬉し

    torazuka
    torazuka 2015/02/12
    こういうふうにリクエストをまとめて提示されると、なるほどと感じる。対応するかどうかは書き手の自由なんだから、クレクレ乙とかカリカリしなくてもいいと思う
  • YARD - A Ruby Documentation Tool

    What Is YARD? YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Above is a highlight of the some of YARD's notable features. And of course YARD comes with muc

  • 自由であるためにドキュメントを作る - 設計者の発言

    前回記事で、ドキュメンテーションを重要視しない開発業者を避けるべきだと指摘した。同様の問題は、業務システムを内製した場合にも生じている。むしろ、ドキュメントレスな困ったシステムは、内製で生み出されているケースのほうが多いような印象が私にはある。 ドキュメントレスなシステムが重大なリスクを抱えていることを、ほとんどの経営者は認識していない。なぜなら、ドキュメントレスであってもシステムのあり方は内製担当者の「頭の中」に入っているので、彼に頼めば必要な改修はやってもらえるからだ。結果的に業務システムが、担当者のエンプロイアビリティ(雇用意義)を強化するための政治的ユーティリティと化すことを許してしまう。その歪みは、担当者がいなくなったときに一挙に顕在化する。いなくなった当人としては「後は野となれ山となれ」である。 業務システムがドキュメントレスになりがちな根的な理由は、まさにここらへんにある。

    自由であるためにドキュメントを作る - 設計者の発言
    torazuka
    torazuka 2014/10/22
    うっ……何かを思い出しかけて胃が
  • yuzen

    YuzenYuzen is a static contents generator similar to jekyll. Yuzen is a Gradle Plugin Yuzen uses Thymeleaf for clean template Yuzen uses Bootstrap for design Yuzen translates Markdown to HTML5 Yuzen parses Markdown by Pegdown Yuzen contains some useful templates blog slide site (this one) Yuzen publishes contents to … GitHub Pages Amazon S3 FTPS server Requirements java7 or more tested by 1.7.0_07

  • 1