タグ

documentationに関するkenjiro_nのブックマーク (23)

  • ノーコードでアプリ内製進めるLIXIL、2万個超えでも「野良」を生まない仕組み

    LIXILはDX(デジタルトランスフォーメーション)を推進するため、米Googleグーグル)のノーコード開発ツール「AppSheet(アップシート)」を採用した。2022年7月29日時点で、2万個を超えるアプリケーションを内製し、このうち839個を番運用している。AppSheet活用の狙いについて、同社の岩﨑磨常務役員デジタル部門システム開発運用統括部リーダーは「(情報システム部門に該当する)デジタル部門が開発すべきシステムやアプリにフォーカスできるようにする」と語る。 LIXILがAppSheetを導入した背景には、デジタル部門の負荷増大があるという。「社内でデジタル技術の活用が進んだことにより、デジタル部門が社内の全ての案件に対応するのが難しくなってきている」(岩﨑常務役員)。そこで経営レベルで費用対効果の大きいシステムやアプリをデジタル部門が開発し、小さいものは現場が自ら開発する

    ノーコードでアプリ内製進めるLIXIL、2万個超えでも「野良」を生まない仕組み
  • 技術コンテンツの流通に「橋」をかける ── ITエンジニアが本を書き、そして作ること - GeekOutコラム

    こんにちは、武藤健志(@kmuto)と申します。 編集制作プロダクションのトップスタジオという会社の執行役員として、編集・DTP・インフラ管理、そして新しい制作技術の研究開発を業務にしています。 「編集制作プロダクション」といっても出版業界以外にはまったく通じなさそうな業種だと思いますが、出版社やメーカーを顧客として、企画・執筆や翻訳・編集校正・装丁、DTP(紙面レイアウト配置)のいずれか、あるいは全部を行い、印刷所に渡せる状態のデータ(今はおおむねPDF)を納入する、というのが当社の守備範囲です。各社の技術書の制作を中心に手掛けており、皆さんのお手持ちの書籍の中にも当社が制作に関わったものがあるかもしれません。 個人としては、Debian Projectの公式開発者のひとりでもあります。「完全にフリーソフトウェアで構成されたOSの実現」を標傍しDebian GNU/Linuxなどを開発す

    技術コンテンツの流通に「橋」をかける ── ITエンジニアが本を書き、そして作ること - GeekOutコラム
  • 我々はいかにシステム開発におけるドキュメント腐る問題と戦えば良いのか

    フューチャーアーキテクト Advent Calendar 2017 の2日目です。 システム設計が大好きで大嫌いな皆さん、こんにちは。 突然ですが、皆さんはどのようにシステム設計における ドキュメント腐る問題 に立ち向かっていますか? … ドキュメント腐る問題とは、設計時に作成した各種ドキュメントがGoogle Driveやファイルサーバ上で陳腐化してしまい、現状の正しい状態を指していないことです。せっかく新規参画者がキャッチアップしようとしてもドキュメントが真実を示していないという怖いやつですよね。 今まで出会った一番辛いドキュメントは、PJ初期に作成したホワイトボードに書かれたラフスケッチの画像しか無かったところですね。まず字が汚いし、内容も最新版と微妙に異なっていました。新規参画者殺しにもほどがあると、ほんのちょっとだけ恨みました。 いやいや、ちゃんとサボらず整合性を取れよって?サボ

    我々はいかにシステム開発におけるドキュメント腐る問題と戦えば良いのか
  • phpDocumentorでドキュメントの自動生成

    javaにはjavadocと言う、ソースファイルからjavaのリファレンスマニュアルを生成してくれるコマンドがありますが、phpにも同様のものとしてphpDocumentorがあります。これはPEARパッケージの1つとして提供されていて、PEARを導入していれば簡単にインストールが可能です。 phpDocumentorの特徴としては、ドキュメントのoutput形式として、下記のようなフォーマットがサポートされています。 html(複数のテンプレートから選択が可能) PDF Windows Help インストールはpearコマンドで簡単にインストール出来ますが、memory_limitがデフォルト値(8M)のままだとメモリー不足でインストール出来ませんでした、php.iniを修正してmemory_limitを16Mに増やせば問題なくインストール出来きました。 ;;;;;;;;;;;;;;;;

  • PHPの開発環境を構築する(その6): PHPDocumentorを試す | 悠雀堂ブログ

    Javadoc(あるいはDoxygen)のように、PHPにもPHPDocumentorというAPIドキュメントを作ってくれるツールがあります。(DoxygenもPHPに対応しているようですが、PHP界ではこちらのほうがメジャーなようです。) 稿では、PHPDocumentorをインストールして、実際に利用してみます。 (2014年12月23日追記:Pleiades All in One Eclipse 4.4 Luna PHP fullでのインストールについて追記しました。) (2015年2月26日追記:インストール方法については「Composerによるツールのインストール」を起稿しました。こちらをご参照下さい。) はじめに Eclipse+PDTを使っていると自動的にPHPDoc形式のコメントを生成してくれて便利です。 しかし実際にレポートを生成してみないと、コメントの仕方もわかりませ

    PHPの開発環境を構築する(その6): PHPDocumentorを試す | 悠雀堂ブログ
  • phpDocumentorの書き方 - Qiita

    phpDocumentorの書き方ってこれ!っていうベストプラクティスがなくて(ドキュメントとはそういうものなのかもしれないけど…)、毎回試行錯誤して、フォーマットを考えるだけでも時間を取られるので、一度自分なりのフォーマットをまとめたいと思います。 今回は、クラスとメソッドについてまとめています。 プロパティについても書いたほうがドキュメントとしてはよいと思うのですが、プロパティまで書き出すとなかなか継続出来ない(ダメ人間です)ので、追々。。 ちなみに、CakePHPをやんわり想定しています。 では、まずクラスについて。 クラス:フォーマット /** * [区分]クラスの概要 * * クラスの詳細 * 出来るだけ細かく書いたほうがよいが、詳細な説明は各メソッドに任せる。 * 全体での共通ルールとか仕様を書く。 * * @access アクセスレベル * @author 名前 <メールアド

    phpDocumentorの書き方 - Qiita
  • 【PhpDoc】コメントの書き方のまとめ – 小俣泰明(タイメイ)ブログ@アルサーガパートナーズ

    関数/メソッドの場合 例文 /** * aaaの説明 * * @param string $arg 第一引数 * @param integer $arg2 第二引数 * @return array 戻り値の説明 */ function aaa($arg,$arg2){} 型 string integer object(オブジェクト) array mixed(いろんな型が返る場合), resource(リソース型) 変数/define定数 /** * 説明 * @see 関連関数 */ のように書きます。 クラスの場合 /** * クラスの説明 * * @package パッケージ名:ここは、自分でうまく分類作れれば見やすくなる * @author 作った人 * @since PHP 5.3 PHPのバージョンとかいれときます? * @version 1.0.1 */ DocBlockとは?

    【PhpDoc】コメントの書き方のまとめ – 小俣泰明(タイメイ)ブログ@アルサーガパートナーズ
  • 文書化軽視(Architecture By Implication) - Strategic Choice

    文書化軽視(Architecture By Implication、言外のアーキテクチャ) 別名 アーキテクチャって何?(Wherefore art thou architecture?) どういうこと? 開発中のシステムに、アーキテクチャ仕様書がありません。これを「文書化軽視」と呼びます。 そのプロジェクトの担当アーキテクトが、前にも似たようなシステム構築の経験があり、文書は要らないと考えます。この自信過剰が、システムの成功を左右する重要な部分でリスクを増大させます。 どうしてダメ? アーキテクチャ仕様書がないと、「スケール」「ドメイン知識」「技術」「複雑さ」などを原因とするリスクが、プロジェクトの進行と共に顕在化します。 アーキテクチャ仕様書がないと、「性能の不足」「過剰な複雑性」「要件に関する誤解」「ユーザから見た使いにくさ」など、プロジェクトの失敗やシステムの不良化の危険性が高くな

  • 最近コード中のTODOコメントの書き方を工夫している - $shibayu36->blog;

    コード中に後でやろうと思って以下の様なTODOコメントを書くことがあります。TODOコメントというのは # TODO: 後でリファクタリングしたい ... # TODO: 投稿機能ができたら置き換えること ... みたいなやつです。 コード中にTODOコメントを気軽に書いてしまいがちですが、よくTODOコメントが放置されて気づいたらプロジェクト中に大量のTODOコメントが書かれたりすることがあります。直せる量を超えてくると、直すモチベーションも下がってきて、結局ただのコメントと同じ状態になります。 最近いろいろ工夫して、TODOコメントの書き方を変えたところ、そこそこうまく回ったのでメモしておきます。 TODOコメントの問題点 問題点として次のものがあると考えました。 (1) 書く人によって形式がバラバラ TODO, XXX, FIXMEなどバラバラだったりする (2) TODOコメントの

    最近コード中のTODOコメントの書き方を工夫している - $shibayu36->blog;
  • Makefileを自己文書化する | POSTD

    私たちのプロジェクトではいつも、非常に長い Makefile を使用して、インストールやビルド、テスト、デプロイメントの処理を自動化しています。ターゲット名はほとんど標準化されていますが( make install 、 make deploy )、中には説明が必要なものもあります( make run-dev 、 make restart-api )。そして、詳細なmakeターゲットを追加するほど、それらの処理内容をテキスト形式で大量に記載しなければなりません。私たちのプロジェクトでは通常、このような文書を README ファイルに書いています。 しかしCLI(コマンドラインインタフェース)を用いる場合は、主に自己文書化ツールを使っています。 make と打つだけで、利用可能なコマンドとその説明が一覧表示されたら便利だと思いませんか? それを実現するのは、実はとても簡単です。まずは各ターゲッ

    Makefileを自己文書化する | POSTD
    kenjiro_n
    kenjiro_n 2016/03/29
    makeのタグがなかった。
  • Redmine で技術仕様書を書こう

    はじめまして! 株式会社 Aiming の土井です! エンジニアをやっております! 今回の開発者ブログでは、情報共有ツールとしての UML の活用方法について、現場での取り組みをご紹介させていただければと思います! 技術仕様書の“図” どうやって書いてますか? 株式会社 Aiming では、プロジェクトの Wiki やバグトラッキングに Redmine をメインに使っています。みなさんも既にご存知だったり、実際にバリバリ活用されていることとおもいます。 また、企画仕様書、技術仕様書などは Redmine の Wiki やエクセルに代表されるオフィススイート等を活用して作成しますが… 図の表現を求められるような仕様書を作る時に、どうやって作成しようか悩んだことはありませんか? 標準ペイントソフトで頑張って作成 オフィススイートに含まれる、ドローツールを使って図を作成、画像吐き出し というケー

    Redmine で技術仕様書を書こう
  • 保守開発に開発者として入って困ることのまとめ(実体験) - Qiita

    このページについて 保守開発にほぼ縁がなかったのですが、最近保守開発に携わわることも増えたので、そのまとめです。 普段のシステム保守に関わりはなく、業務知識がないエンジニアが、ある程度まとまった保守開発の案件発足時に開発専門でスポット対応したときに困ったことが書いてあります。 ここに書く困った事案について対応しておくと、スポット対応や保守PJで増員or要員入れ替えで新参者を迎え入れた場合に、新しく入った人が困ることは少なくなると思います。 ※保守開発の経験が増えて困った事案があれば、(愚痴にならないようにときにはネタを仕込んで面白おかしく)ここに書き足します。 ドキュメント周りで困ること 単語集がない 新規開発も同じですが、新参者に取ってPJへの途中参加は、日語以外が飛び交う海外に行くのと同じです。新参者は業務用語が判らないので、業務用語の単語集があると喜びます。 単語集の整備は軽視され

    保守開発に開発者として入って困ることのまとめ(実体験) - Qiita
  • C# Visual Studio 2012 Professional で SHFB (Sandcastle Help File Builder) を使う | HTML5 CSS3 JavaScript – WEBYA.IN

    C# Visual Studio 2012 Professional で SHFB (Sandcastle Help File Builder) を使う Java でいう Javadoc 的な、C# 版の javadoc、いわゆる「ライブラリとしてのドキュメントを生成」ができるツールがないかと探していたら、Sandcastle Help File Buider というものを見つけた。 いろいろ調べてたんだけどちょっち古いのが多く、新しい環境ではなかなか動かすところまで行き着けなかったので、確実に実現するところまでを記すよ。(2013.01.08 時点) 尚、この手順は Visual Studio 2012 Professional がインストールされている前提で進めます。 ダウンロード 右部のサイドバー、紫の「download」ボタンでダウンロードが始まります CodePlex – Sna

  • C#でJavaDoc風のAPIリファレンスを作成する方法 - redwarrior’s diary

    C#でも、Javaで言うところのJavaDocみたいなコメントの書き方があります。 ドキュメントコメントと呼ばれていて、///で始まり、paramタグとかreturnsタグとかを書くことが出来ます。 このドキュメントコメントから、APIリファレンスを作成する方法を調べたので書いておくことにします。 今回、APIリファレンスを作成する対象は、Spracheというパーサージェネレーターです。 これはチュートリアルがあって結構わかりやすく書いてあるのですが、APIリファレンスが無いので使用する時に何を使えばいいのか困ります。 ソースを確認したところ、ドキュメントコメントは書いてあったので、APIリファレンスを作成して、ついでに手順をブログにまとめておこうという算段です。 まず、いつもの通りに先人の知恵を借りるということで、以下の2サイトを参考にさせてもらいました。 d.hatena.ne.jp

    C#でJavaDoc風のAPIリファレンスを作成する方法 - redwarrior’s diary
  • C# VB.Net におけるソースコードのドキュメント化(Sandcastle) - Qiita

    C#/VB.Netで開発をしていて、JavaDocいいな・・・なんてさみしい思いをしたことはないでしょうか。 実は、Sandcastleというツールを使用することで.NETでもソースコードからドキュメントを生成できます(こんな感じ)。今回はその方法をご紹介します。 Sandcastleのインストール Sandcastleはもともとマイクロソフトが開発していたのですが、2010年ごろおやめになってしまい(ええっ!?)、それからしばらく.NETではJavaDocのようなツールがない状態でした。 その後(2012~2013年ごろ?) Eric Woodruffという心優しい方が元プロジェクトをforkし新たにSandcastle Help File Builderとして開発を行ってくださり、今に至ります。 前書きはこれくらいにして、ありがたくインストーラーを頂戴します。 https://gith

    C# VB.Net におけるソースコードのドキュメント化(Sandcastle) - Qiita
  • Software/Doxygen - CX's MEMO

    2013-05-15 Hello, Tkinter World! 2013-05-14 Hello, Ruby/Tk World! 2013-05-13 Hello, Perl/Tk World! 2013-05-12 Hello, Tcl/Tk(C言語) World! 2013-05-11 Hello, Tcl/Tk World! 2013-05-03 Hello, Win32 API(Quercus) World! 2013-05-01 Hello, Quercus World! 2013-04-18 Hello, JDBC Type4(Oxygene) World! 2013-04-17 Hello, JDBC Type2(Oxygene) World! 2013-04-16 Hello, JDBC Type1(Oxygene) World! 2013-04-15 Hello, Co

  • ecloxとdoxygenで仕様書メンテナンスの効率をUP!

    ecloxとdoxygenで仕様書メンテナンスの効率をUP!:生産性向上への道 Eclipseで行うC/C++開発(4)(1/4 ページ) 連載では、組み込み開発に「Eclipse」を適用するメリットおよび適用方法の概要を紹介してきましたが、今回でいよいよ最終回となります。 第1回「組み込み開発におけるEclipseの有効性」では、EclipseのメリットやC/C++開発に利用できるプラグインの紹介をしました。第2回「『CDT』で効率的なC/C++開発を実現する」と第3回「CDT/RSEによるクロスコンパイルとリモートデバッグ」では、CDTとRSEを利用したC/C++アプリケーションの開発方法を紹介してきました。 最終回となる今回は「eclox」と「doxygen」を使ったドキュメントの自動生成について解説します。 今回の内容を読み進める前に、これまでの連載記事をもう一度読んでおくと、よ

    ecloxとdoxygenで仕様書メンテナンスの効率をUP!
  • Doxygenを利用したソフトウェア詳細設計書の作成 - 株式会社ライト・ライト

    投稿日:2012/04/3 作成者:TZ 弊社ではソフトウェア詳細設計書の作成時にDoxygenによる自動生成された情報を活用しております。 これはDoxygenを用いる事で以下のメリットを得ることが期待できるためです。 コードに設計内容が埋め込まれているため、コードと設計書の乖離が軽減され保守性が向上する コメントにDoxygenに対応したタグを埋め込むだけなので低コストで詳細設計書が作成可能である 関数の呼び出し関係や、ヘッダの依存関係図の生成、各種情報へのハイパーリンクの設置など詳細設計書としての内容も高品質である ドキュメント生成時に引数説明の記述もれ等の問題があれば指摘されるため、単純ミスが軽減され設計書の品質が向上する 記載内容などが属人的にならずに設計書の品質が安定する また、ソフトウェアの基設計時にDoxygenに対応した簡素なプロトタイプのコードを作成する事で、設計の妥

  • サービス終了のお知らせ - NAVER まとめ

    サービス終了のお知らせ NAVERまとめは2020年9月30日をもちましてサービス終了いたしました。 約11年間、NAVERまとめをご利用・ご愛顧いただき誠にありがとうございました。

  • eclox - ViVa! Saborigineer.

    ** Eclipseとdoxygenの連携 [[Eclipse]]と[[doxygen]]が連携できた場合、そのメリットは絶大です。 doxygenの設定はGUIでできるし、ボタン1つでドキュメントの生成もできるし。 何より、C/C++の開発環境がJAVAの開発環境にグッと近くなります。 こんなことを実現してくれるEclipseプラグインがあるんです。 …それは「[[eclox>http://home.gna.org/eclox/]]」。 これについては、日語の説明サイトが見つからなかったのでちゃんと書きたいと思います。 #contents() ** Ecloxのインストール インストールは簡単です。 ⅰ.Eclipseを起動する。 ⅱ.「ヘルプ」→「ソフトウェア更新」→「検索およびインストール」を選択 ⅲ.「インストールする新規フィーチャーを検索」を選び、「次へ」 ⅳ.「新規リモート・

    eclox - ViVa! Saborigineer.