タグ

documentに関するbigwestのブックマーク (21)

  • esaによる社内活性化

    ノハナの中の様子を時に真面目に時にゆるゆるとお伝えします こんにちは、ノハナの原田です。 サーバーエンジニアです。 最近、社内ナレッジ共有のためにesaというWebサービスを導入しました。 社内の活性化に寄与しているのでここで紹介します。 導入のきっかけと選定 ノハナではナレッジの共有に、プロジェクト管理ツールに付随しているWikiを使っていましたが、以下のように使いづらい点がありました。 記事を書く際にリアルタイムプレビューがない 記事を書く際に画像をドラッグ貼り付けできない 記事URLに記事タイトルを含んでいて、タイトル変えるとリンク切れになる 更新通知がメールだけでWebHook通知ができない さらに、この1年でメンバーが20人から30人の規模に膨らんでおり、既存ツールの運用見直しや移行の機運が高まってきた中で、有志メンバーによって移行の検討が始まりました。 同様のサービスがたくさん

    esaによる社内活性化
  • 【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO

    はじめに こんにちは植木和樹@上越妙高オフィスです。日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 (この記事を読むのにかかる時間の目安:5分) 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1

    【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO
  • Markdown記法+Git+md2review+ReVIEWで原稿・ドキュメント管理 - プログラマでありたい

    来年は、インプットあたりのアウトプットの増加を目指しています。具体的なアウトプットとしては、ブログを書くこともその1つですし、公開・非公開を問わずに効率的にドキュメントを書いていくこともあります。その中で効率的にドキュメントを書くには、バージョン管理を含めドキュメントを管理する仕組みが必須だと思います。以前、原稿を書いていた時は、Git+MS Wordで書いていました。版管理出来るという点では良いのですが、Wordということで執筆出来る端末も限定され、またフォーマット変更もしづらいので改善を考えていました。 そんな中で、IT系の物書きの人たちの間でReVIEW良いよという話を何度も聞いたので試してみようと思いました。一方で、記述のデファクトは今後はMarkDownになると思うのでそちらもマスターしたいと考えています。Twitterで何気なく呟いたら、@masawadaさんにmd2rev

    Markdown記法+Git+md2review+ReVIEWで原稿・ドキュメント管理 - プログラマでありたい
  • AWS News Blog

    AWS Weekly Roundup – AWS AppSync, AWS CodePipeline, Events and More – August 21, 2023 In a few days, I will board a plane towards the south. My tour around Latin America starts. But I won’t be alone in this adventure, you can find some other News Blog authors, like Jeff or Seb, speaking at AWS Community Days and local events in Peru, Argentina, Chile, and Uruguay. If you see […] New – Amazon EC2 H

  • SEが苦手にしがちなドキュメント力を強化する5つの視点

    SEに最も必要なスキルは「伝える力」だと言われています。分業が前提となるシステム開発において、意志の伝達がうまく出来ないことは致命的だからです。 よって、作成するドキュメントにも正しく伝える技術が求められるのですが、しかし多くのSEはドキュメント作成を苦手としているようです。 そこで今日は、SEがドキュメント作成で失敗しがちなポイントと、ドキュメント力を強化するための5つの視点について、『エンジニアのための文章術再入門講座』からご紹介します。 1.SEがドキュメント作成で失敗しがちなポイント SEがドキュメント作成に失敗しがちなポイントは、主に以下の2つです。 相手の関心と不一致 知識差のための説明が不足 例えば、システム開発プロジェクトの部長向けの進捗報告の場面を思い浮かべてください。性格にもよりますが、一般に部長クラスの方が気にするのは「予算を超過しないか」「顧客との関係は良好か」「今

  • Mac用ドキュメント管理アプリ「iDocument Lite」を試す | Mac App Store | Macお宝鑑定団 blog(羅針盤)

    IcyBlaze Software Incが、Mac用ドキュメント管理アプリ「iDocument Lite」を、Mac App Storeにて無料配付を開始していたので試してみました。 無料版では、扱えるドキュメント数が500個までという制限があります。 テキスト、PDF、Word、Pagesなどのドキュメントファイルを管理することが出来ます。 ドキュメントファイルにフラグを付けたり、ラベルやレートを付けたりすることが出来ます。 なお、EPUBファイルには対応しておらず、PDFファイルなどをブック形式で見るビューワ機能は装備されていません。

    Mac用ドキュメント管理アプリ「iDocument Lite」を試す | Mac App Store | Macお宝鑑定団 blog(羅針盤)
  • Pythonドキュメントの日本語訳のPDFがすごい - 偏った言語信者の垂れ流し

    先日公開されたPythonドキュメントの日語訳のPDFがすごい。なにがすごいって、ページ数が合わせて3000ページぐらいあるところが。 ダウンロードファイル一覧 - Python Japanese Environment - OSDN いつもお世話になってます。ドキュメントの著者、翻訳者の方々に感謝。 追記 このPDFはSphinxというドキュメンテーションシステムを使って出力されてます。 オリジナルはreStructuredTextという形式のテキストファイルです。 Overview — Sphinx 1.4.3 documentation Sphinx-Users.jp — Python製ドキュメンテーションビルダー、Sphinxの日ユーザ会 Google Project Hosting

    Pythonドキュメントの日本語訳のPDFがすごい - 偏った言語信者の垂れ流し
  • ソーシャルライブラリーサービス「Baiduライブラリ」β版本日オープン | Baidu Japan Blog

    こんにちは。バイドゥライブラリチームです。 Baiduは日、気になる資料や自分の作品などをオンライン上で閲覧・共有できる、ソーシャルライブラリーサービス「Baiduライブラリ」β版を公開しました。  「Baidu ライブラリ」では、さまざまな形式のドキュメント(文書)を閲覧・アップロード・ダウンロードすることができます。また、他のユーザーがアップロードしたドキュメントを保存したり、評価(レビュー)したり、ブログやHPに張りつけてみんなに紹介することができます。  ビジネスに関すること、学校での勉強に関すること、趣味に関することなど、さまざまなジャンルでの知識をまとめ、共有することができる場所、それが「Baiduライブラリ」です。 ビジネスにおけるプレゼン資料や自作の小説、オリジナルの料理レシピ、住んでいる街のお店情報が載った地図や自分の作品公開などの場としてお使いいただけます。 あなたが

  • 富士フイルム、ドキュメント画像変換技術「GT-Document」のAPIをトライアル公開

    富士フイルムは8月16日、携帯電話向けリモートアクセスサービス「Keitai Remoteメールアクセス」に搭載しているドキュメント画像変換技術「GT-Document」のAPIをトライアル公開した。 GT-Documentは、ドキュメントファイルのそれぞれのページを、富士フイルムのサーバ上で高解像度のJPEG画像に変換し、配信先の機器の画面に合わせて最適化した上で自動的に圧縮・配信する技術。同社では、GT-Documentを利用することで遠隔地からでもスムーズなドキュメント閲覧ができるほか、独自の画像処理技術により、文字や図面などの線画データをにじみやかすれが少なく高品質に表示できるとしている。 今回のAPIのトライアル公開は、2010年12月に提供を予定している、GT-Documentのクラウド型サービスの開始に先立ち、現行バージョンを広く試用してもらうことを目的としたもの。GT-Do

    富士フイルム、ドキュメント画像変換技術「GT-Document」のAPIをトライアル公開
    bigwest
    bigwest 2010/08/28
    コレは使いたい
  • わかりやすい技術文章の書き方

    誰が読むのか。 読み手にどんな感想を持ってもらいたいか。 読み手はどれくらいの予備知識を持っているか。 読み手はどんな目的で、何を期待して読むのか。 読み手が真っ先に知りたいことは何か。 レポート・論文とは何か 問いが与えられ、または自分が問いを提起し、 その問題に対して明確な答えを与え、 その主張を論理的に裏付けるための事実・理論的な根拠を提示して、主張を論証する。 標準的な構成要素とは何か レポート・論文の構成は、 概要 序論 論 論議 という要素が標準的である。次にそれぞれの要素について簡単に見てみる。 概要 論文全体を結論も含めて、すべて要約する。 序論 論で取り上げる内容は何か。 その問題をどんな動機で取り上げたのか。 その問題の背景は何か。 その問題についてどんなアプローチを取ったのか。 論 調査・研究の方法・結論 論議 自己の議論・結論を客観的・第三者的に評価する。 そ

  • Webサイトの制作/運用の効率化を図る 「ガイドライン策定」のすすめ(前編)(1/4):CodeZine

    Web標準に従うことは、SEO効果、ユーザービリティ、メンテナンス性の向上など、Webサイトの利用者と制作者の双方にさまざまなメリットをもたらします。しかし、実際にWeb標準の仕様書に従ってWebサイトを制作しようとすると、制作者の頭を悩ませる多くの問題が待っています。連載では、Web標準のメリットを最大限に生かすことをテーマに、仕様書には書かれていない部分を中心に取り上げ、実際のWeb制作現場で起こり得る問題について、解決の糸口をたらしていきたいと思います。 はじめに Web標準に従うことは、SEO効果、アクセシビリティ、ユーザービリティ、相互運用性、互換性、メンテナンス性の向上など、Webサイトの利用者と制作者の双方にさまざまなメリットをもたらします。しかし、実際にWeb標準の仕様書に従って「正しい(X)HTML+CSS」でWebサイトを制作しようとすると、制作者の頭を悩ませる多くの

    Webサイトの制作/運用の効率化を図る 「ガイドライン策定」のすすめ(前編)(1/4):CodeZine
    bigwest
    bigwest 2008/12/10
    Webサイトのガイドライン
  • MOONGIFT: » ネットワーク図を簡単に描ける「Network Notepad」:オープンソースを毎日紹介

    ちょっと懐かしめの、それでいて現役で役立つソフトウェアの紹介だ。 オフィスのLAN配線図や、Webサービスのサーバ配置図を作る際にネットワーク図を作ることがある。Microsoft Visioがあれば良いが、高価なソフトウェアだけに全員分は難しい。とは言え、単なる四角などではちょっと雰囲気が出ないので寂しいだろう。 ネットワーク図を簡単に作成する そこで使ってみたいのがNetwork Notepadだ。Windows向けのフリーウェアで、ネットワーク図を作成するのに必要な機能およびアイコンが多数登録されている。 Network Notepadは各種オブジェクトを配置して線で結んだり、水平線を引いたりしてネットワーク図を作成するためのソフトウェアだ。もちろんオブジェクト同士をつないだ線は、オブジェクトの移動に合わせて長さが変わるようになっている。 多数のオブジェクトが存在する IPアドレス

    MOONGIFT: » ネットワーク図を簡単に描ける「Network Notepad」:オープンソースを毎日紹介
  • ハーバード大学医学部留学・独立日記 第二部 三重大学医学部編 ... 論文力のつけ方

    ボストンで13年働いた研究者が、アカデミック・キャリアパスで切磋琢磨する方法を発信することをめざします。 2025/06 « 12345678910111213141516171819202122232425262728293031» 2025/08 当たり前に聞こえるかもしれませんが、質の高い論文や原稿を書くためのコツは、何回も書き直すことです。通常は初稿があがった時点で同僚や共同研究者に見せてコメントをもらいたいところですが、ここではあえてそれを薦めません。というのは初稿は通常非常に陳腐なアイデアや表現が詰まっていることが多いからです。 なぜでしょうか。実は、論文を書くという行為はプレインストーミングとよく似ています。ブレインストーミングの仕掛けは「アイデアはどこにあるか:Tim Hurson著 Think Better」で書いたように: ークリエイティブな素晴らしいアイデアは後半1/

  • Google Japan Blog: 日本のデベロッパーの要望に応え、多くの技術ドキュメントを日本語化しました

    Google が提供するさまざまなAPI やツールの詳細な技術情報は、すべて Google Code で公開されています。しかし、全ての技術情報は英語で記されていたため、多くの日のデベロッパーからは技術ドキュメントを日語化して欲しいとの要望をいただいていました。 そこで、 開発者ホーム と題して Google Code の日語版の運用を開始しました。4月より、2 つの技術、OpenSocial と YouTube Data API技術ドキュメントの日語版の提供を開始しました。そして、Google Developer Day 2008 Japan の開催にあわせ、さらに多くのドキュメントと映像を日語化しました。 日、日語版が公開されたドキュメントおよび映像は以下となります。 OpenSocial YouTube Data API Google Gadgets API Goo

    Google Japan Blog: 日本のデベロッパーの要望に応え、多くの技術ドキュメントを日本語化しました
  • 【祝完了】 オレの和訳にオマエが泣いた - Google App Engine - 暗号、数学、時々プログラミング

    Google App Engine | 04:50 | はじめに このエントリーは、先に公開した記事「道に迷ったアナタに捧ぐ(関連記事のまとめ)」が原因不明の事象により直リンクでは見えない!という問題に対処する目的で作成されました。中身は基的に変わりません。なんだかブックマークを見ていて「まとめ記事」の存在をご存知頂けていないッポイな、、という気がしたもので、日の「超訳完了記念」に合わせて再度作成してみた次第です。どの記事が何に言及したものかよく分からん!とお怒りの方々の為に少しでも助けになれば幸いです。Google App Engine の公開から約2週間。毎日結構な方のアクセスがあった事が励みになり、スピードを落とさずに超訳作業が完了出来ました。スターやブクマ、コメントを下さった皆さんだけでなく、アクセス頂いた全ての方々に感謝したいと思います。また、多くの皆さんにブログをご覧頂く

  • 3分LifeHacking:他人の作った書類を閲覧する - ITmedia Biz.ID

    営業報告の日報や、見積書、契約書、請求書、稟議書……。社内文書としてテンプレートを用意している会社もあるだろうが、テンプレートにできないような報告書の類もありそうだ。そんな時、他人の作った書類が何かの参考になるかもしれない。 ビジネスではいろいろな書類を作成する。営業報告の日報や、見積書、契約書、請求書、稟議書……。社内文書としてテンプレートを用意している会社もあるだろうが、テンプレートにできないような報告書の類もありそうだ。そんなさまざまな書類だが、他人の作った書類が何かの参考になるかもしれない。日米で盛り上がりつつあるドキュメント共有サイトで、そんな他人の作った書類を見てみよう。 紹介するのは、読み方が難しい「Scribd」、OKWaveが提供する「docune」、2月にリニューアルしたばかりの「Hot.Docs」だ。いずれも投稿したドキュメントを共有できる。しかもYouTubeのよう

    3分LifeHacking:他人の作った書類を閲覧する - ITmedia Biz.ID
  • HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方

    HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方 目次 この文書について 設計文書のうまい書き方 なぜ設計文書を書くのか 良い設計とは何か 同僚の開発者に向けて書く 第 1 節に書くこと: プロジェクト/サブシステムの目的を示す 第 2 節に書くこと: 設計に使う高レベルなエンティティを定義する 第 3 節に書くこと: 個々のエンティティに関する低レベルの設計を書く 使い方 設定 モデル 相互作用 第 4 節に書くこと: 利点, 前提, リスク/懸念事項 マネージャ向けに書くこと 最後に 設計文書のうまい書き方 この文書について "How to Write an Effective Design Document" の日語訳です. http://blog.slickedit.com/?p=43 推敲歓迎: 誤訳, タイポ, 訳語の不統一,

  • 実用 DocBook 入門

    これは DocBook の使い方の実用的な入門書であり,初心者を念頭に置いて 書かれています.将来的にはこの文書は実作業に基づいたタグのリファレンス や,より多くの例を含むようになるでしょう.

    bigwest
    bigwest 2006/12/09
    DocBook入門
  • Doxygen

    ソースコード・ドキュメンテーション・ツール Doxygen は、C++、C、Java、Objective-C、Python、IDL (Corba、Microsoft 風)、Fortran、VHDL、PHP、C# 向けのドキュメンテーション・システムです。 D にもある程度対応しています。 Doxygen には、次の3つの利点があります。 文書化されたソースファイルのセットから、 オンライン・ドキュメント・ブラウザ (HTML形式) やオフラインのリファレンス・マニュアル (形式) を生成することができます。 RTF (MS-Word)、PostScript、ハイパーリンク PDF、圧縮 HTML、Unix man ページ形式の出力もサポートされています。ドキュメントは、ソースから直接抽出されます。これにより、ドキュメントとソースコードの一貫性を保つことがとても容易になります。 Doxyge

    bigwest
    bigwest 2006/12/04
    開発ドキュメントツール
  • Apache のドキュメントを htmlhelp で - 2nd life (移転しました)

    http://rails2u.com/htmlhelp/httpd-docs-2.0.58.ja.chm http://rails2u.com/htmlhelp/httpd-docs-2.2.2.ja.chm windows 使いには htmlhelp 大好きな人がわりといると思います。かく言う私も htmlhelp 大好きで、rubyhtmlhelp が無かったらたぶん ruby 書けませんし、ruby 自体覚えていなかっただろう、というぐらい依存度が高いです。で、この htmlhelp が結構いろいろなアプケーションで存在してたりします(参考: はてなダイアリー - 大西日記 - HTML Helpを使おう)。 で、今まであったらいいなと思ったのが Apache の htmlhelp。Apache の設定を弄ってたりするとき、わざわざ Web 上のドキュメントを参照するのは結構面

    Apache のドキュメントを htmlhelp で - 2nd life (移転しました)
    bigwest
    bigwest 2006/08/23
    リファレンス