タグ

ドキュメントに関するakatuki_satoのブックマーク (6)

  • 【最新版】DocBase(ドックベース)の使い方や評判・料金を紹介!

    日々の業務におけるナレッジやノウハウは、社内で適切に蓄積し、管理することで、企業の利益向上につながります。そのため、社内の書類やマニュアル、業務メモなどをデジタル化できる「情報共有ツール」を用いて、社内情報を管理する企業が多いです。 たとえば、情報共有ツールのひとつに「DocBase(ドックベース)」があります。しかし、「DocBaseの導入を検討しているが、当に自社に適しているか分からない」と悩む方も多いのではないでしょうか。

    【最新版】DocBase(ドックベース)の使い方や評判・料金を紹介!
  • ドキュメントに固執せよ - gfnweb

    どうして人間集団はこんなにも知見の共有を円滑にできないのか? 改善にはドキュメントにまつわる各個人の心構え・制度設計・技術的解決の全部が必要だという話をしたい. ここでテーマにしているのは,著名OSSなど世の中にいくらでも知見が転がっている対象ではなく,特に企業内の十数人のチームでクローズドに開発しているなどして集合知に頼れない状況下でのドキュメントについてである. 非常に乱暴な言い方をするなら,「コードとか大部分は誰でも書けるようになるものなんよ,そんなところにマッチョイズムとか感じなくてええねん,我々の知的体力や組織性が真に試されるのはドキュメントちゃうんか」という気持ちです — 画力・博士号・油田 (@bd_gfngfn) June 3, 2022 ドキュメントに書く内容の必須項目或るシステム(ソフトウェアなど)について,そのシステムのことを全く知らない人を想定読者としたドキュメント

    akatuki_sato
    akatuki_sato 2022/06/18
    論文を書く経験は大事よな。ただ、文章が長くて読みにくい。。。短くすると読みやすくなると思う
  • JSDoc Toolkit→JSDoc 3移行ガイド | BLOG - DeNA Engineering

    こんにちわ、DeNA San Francisco の渋川と申します。エンジニアブログには初登場です。 JavaScriptのソースコードからAPIドキュメントを生成するツールには何種類かありますが、日語の書籍やウェブサイトでも情報が得やすいこともあって、JSDocの系統が幅広く使われています。Google Closure Compilerも、JSDocを拡張したドックコメントをアノテーションとして読み込んで最適化します。 JSDocは長い期間メンテナンスされているオープンソースプロダクトです。初代はPerlで書かれたJSDoc 1です。これはすでにリポジトリも削除されています。現在最も使われているのが JSDoc Toolkit (JSDoc 2) です。弊社の ngCoreのドキュメント でも使用しています。 ただ、これも現在は機能追加を停止していて、後継プロダクトの JSDoc 3

    JSDoc Toolkit→JSDoc 3移行ガイド | BLOG - DeNA Engineering
  • 綺麗なだけじゃ意味がない!ディレクターが見落としがちな仕様書作成の4ポイント : LINE Corporation ディレクターブログ

    こんにちは。ウェブサービス部の河野です。 ディレクターの業務の重要なものの一つに、仕様をまとめたりドキュメントを作る業務があります。限られた時間の中でシステムを開発しなければならない際に、どのようなドキュメントをどこまで作成するか悩むことも多いかと思います。 そこで今回はディレクターがドキュメントを作成する際の心がけやポイントについて考えてみたいと思います。 1.ドキュメントを作ることが目的とならないようにする 当たり前のことですが、一番重要なのは進めているシステム開発が納期通りに不具合なくリリースできることです。仕様をメンバーに理解してもらうことが第一で、その手段としてドキュメントがあるという優先度を間違えないようにしましょう。 きちんとしたドキュメントの作成には時間が掛かり、変更時の更新にも同じく時間がかかります。また、更新をせず情報が古いままの場合、開発メンバーがそれを最新バージョ

    綺麗なだけじゃ意味がない!ディレクターが見落としがちな仕様書作成の4ポイント : LINE Corporation ディレクターブログ
    akatuki_sato
    akatuki_sato 2013/04/03
    あとで読む。
  • PHPerのMVCの一体どこが間違っていたのか - MugeSoの日記

    メリークリスマス! PHP Advent Calendarもいよいよ24日目に突入です。 昨日はxhprofについてでしたね。僕もパフォーマンスチューニングの際に使っています。手軽に利用できるのでお勧めです。 さて、このエントリーでは表題の通りMVCについて書かせていただきます。これは、PHPカンファレンス2012&WordCamp Tokyo2012合同LT大会で発表した「やはりお前らのMVCは間違っている」で煽るだけだったこの問題をきちんと解説するものです。 この発表資料を公開するとPHPの枠を超えて広く閲覧いただき*1、また多くの方から突っ込みを戴きました。「LTだから」と言って逃げていた回答をして、気持ち新たに新年を迎えようと思います。 MVCとはなんなのか 間違いを指摘する前にMVCがそもそもどういうアーキテクチャであるのかを確認しなければいけません。 MVCは1970年代にパロ

    PHPerのMVCの一体どこが間違っていたのか - MugeSoの日記
    akatuki_sato
    akatuki_sato 2012/12/25
    あとで読む
  • TechCrunch

    Happy Saturday, folks, and welcome to Week in Review (WiR), TechCrunch’s newsletter that covers the major stories in tech over the past several days. I feel inclined to begin this edition with a

    TechCrunch
    akatuki_sato
    akatuki_sato 2011/12/06
    あとで見るぞ
  • 1