タグ

documentationに関するluccafortのブックマーク (4)

  • ESDocという(多分)モダンなドキュメンテーションツールの紹介 - maru source

    こんにちは丸山@h13i32maruです。 僕は2015年からESDoc*1というJavaScript向けのドキュメンテーションツールを開発しています。 https://esdoc.org https://github.com/esdoc/esdoc Star 最初のリリースから2年、昨日ようやくv1.0をリリースできました🎉 いやー、ここまで長かったです。今ではRxJSやSketchAPIなど、様々なツールで使用されています。 この2年間、ESDocは2つのゴールを目指して開発してきました。 ドキュメントの作成・メンテナンスを快適にする(ドキュメントを書くの楽しい!という状態) ソフトウェアの使い方を簡単に理解できるドキュメントを作成する(ソースコード読まなくても大丈夫!という状態) この2つを満たすためにESDocは色々な機能を提供しています。 今日はそれらの機能の中でも(多分)モダ

    ESDocという(多分)モダンなドキュメンテーションツールの紹介 - maru source
    luccafort
    luccafort 2017/08/02
    こういうお役立ちツールがどんどん盛り上がっていってエンジニアやデザイナーにとって住みよい環境になっていくの趣がある。メンテされていかないDocsほど悲しいものもない。あとDocが嘘ついてたときつらい。
  • Scala で実装した社内ナレッジ共有ツールを OSS にして公開しました

    社内の事業部・プロジェクトを跨いで、社員間で技術やノウハウの共有をもっともっと盛んにしたいーそんな社員の声から生まれ、社内で運用中のツールをこの度 OSS にして公開しました。 公開先 GitHub 上に公開しています。 atware/sharedocs README にデモサイトや Heroku ボタンを記載していますので、すぐに試すこともできます。 Sharedocs Markdown で記事が投稿でき、コメントや Like やストックができる、言ってしまうとどこかで聞いたことがある某有名サービスのような情報共有ツールです。 投稿画面 絵文字も入力できますし、さらにはシーケンス図やフローチャートも Markdown で描けます。 レスポンシブにしてあるのでスマホやタブレットでも使えます。 つくるに至った背景など 背景 弊社には以前から、 他のプロジェクトでどんな技術が使われているのかよ

    Scala で実装した社内ナレッジ共有ツールを OSS にして公開しました
    luccafort
    luccafort 2017/01/17
    DocBaswやIncとの違いってなんだろ?と思ってみてたらシーケンスやフローチャート書けるのか。Herokuボタンついてたりデモサイトあったりで非常にわかりやすい印象。ただタグのデザインがイケてないのがちょっと気になる
  • PsySH

    Stop die()ing all the time PsySH can be used as an interactive debugger, much like JavaScript's debugger statement, saving you from endless var_dump() and die() iterations. Just drop this line in where you'd like to have a breakpoint: eval(\Psy\sh()); Auto[tab][tab]Complete PsySH has tab completion for variable names, functions, classes, methods, properties, and even files! Just start typing, then

    luccafort
    luccafort 2016/07/11
    コマンドでドキュメント見れるのは確かに良さある。
  • 技術的な文章を書くための1歩、2歩、3歩 - Qiita

    ちょっと書きたくなったので書くんじゃーい! この文章を読み終わった時、読者がそれなりわかめ品質な文章を出力できるようになり、どこかに寄稿した時に全面リテイクをらったりしないようになることを目指します。 mhidaka が 0歩目を書いてくれました! 背景 筆者は普通のエンジニアです。その辺の開発とかしてる会社に勤めています。技術系の原稿も書きます。 原稿書きでご飯べてるわけではありません(晩ご飯が豪華になることは稀にあります)。 今まで有能なレビューワー(muなんとかさんとか)編集さんとか(某社の安藤さんとか)とかとかに鍛えていただきました。 この場を借りてお礼を述べておきたいと思います。ありがとうございます。 なお、この文章は2013年10月時点での筆者(わかめ)のやり方です。 将来的にはより良いやり方を見つけるでしょうし、これとは全く違う書き方で上手にやっている人もいると思います。

    技術的な文章を書くための1歩、2歩、3歩 - Qiita
    luccafort
    luccafort 2013/10/15
    これだけの文章を3時間でっていうのは個人的には短いと思うんだけども一般的にどうなのかわからん。とりあえずクソを量産するか。でもTypeScriptは…
  • 1