14

開発者として、私はドキュメントを書くのが本当に好きではありませんが、そうしなければならないときは、プロセスをできるだけ簡単にしたいと思っています。

Word の問題は、常に私の邪魔になることです。中身よりもレイアウトが気になる…だからワードはやめたい。

理想的には、自分のコンテンツを書き、それをドキュメントに「コンパイル」したいと考えています。

LaTeXのことは聞いたことがありますが、まったく経験がありません。これは、この仕事に適したテクノロジーでしょうか? どのエディター (Windows) を使用すればよいですか? LyXから始めるのは良い考えですか?

編集: コードの文書化について質問しているわけではありません (そのために Sandcastle を使用しています)。


更新 2014:

現在、 GFM (GitHub Flavored Markdown)に切り替えています。

  • 操作はとても簡単です。
  • 同じ IDE でコードとドキュメントを作成してください!
  • すべてをバージョン管理できます!
  • raw txt、html、またはpdfのいずれかとして優れた出力を取得します。
4

21 に答える 21

26

これに対する私の解決策は、自分用の適切な Word テンプレートの作成に時間を費やすことでした。

重要なことは、ドキュメントに含めることができるすべてのスタイルが定義されていることを確認することです。

すべてのスタイルを定義し、その場しのぎの方法で書式設定するのではなく、正しいスタイルでタグ付けされたすべてのドキュメント コンテンツを作成すると、見栄えの良い Word ドキュメントを毎回すばやく簡単に作成できることに驚かれることでしょう。

ここでのより大きな問題は、誰もが Word で何時間も費やしているにもかかわらず、企業が Word のトレーニングに投資することはほとんどないということです。ある時点で、他のツールと同じように、弾丸を噛んで、時間をかけて適切に使用する方法を学ぶ必要があります.

于 2009-05-14T09:06:33.640 に答える
23

LyX でできることはすべて、LaTeX でもできます。LaTeX はあらゆる種類のものに適しています。マニュアルから講義スライド、小説まで、あらゆるものに使用されています。

LaTeX はおそらくオプションとして検討する価値があると思います。ワープロ用に「コーディング」したいと思ったことがあるなら、LaTeX が最適です。最も単純なレベルでは、何かを実行するための新しいコマンドを定義できますが、そこには多くの機能があります。そして、出力は本当にきれいに見えます。

私の意見では、LyX は特定の状況では素晴らしく、別の状況では便利ですが、時には邪魔になることもあります。LaTeX の生産性を高めるものと見なされるべきだと思います。つまり、LyX を試す前に LaTeX の使い方を学びましょう。どちらももちろん無料で、Windows で利用できますが、MS Word に比べて学習曲線はかなり急です。長いドキュメント、または類似のドキュメントが多数ある場合、LaTeX/LyX はおそらく投資する価値があります。

于 2009-05-14T09:15:43.230 に答える
11

ウィキがこれに適していることがわかりました。少し書式設定を行うことができますが、それほど重くはありません。理想的には、コードも簡単にフォーマットできるようにする必要があります。正直なところ、SO で利用可能なマークダウンはおそらく良いスタートです。

その方法:

  • 変更追跡が組み込まれています (適切な wiki を想定)
  • どこからでも編集可能
  • 全員が常に同じドキュメントを参照 (即時配布)
  • フォーマットではなくコンテンツに集中できます
于 2009-05-14T09:03:39.903 に答える
10

独自の XML 形式を使用してドキュメントを記述し、XSL を使用して任意の形式に変換できます (例: FOP+XSL-FO を介した PDF)。DocBook XML フォーマットも参照してください。

于 2009-05-14T09:03:04.647 に答える
5

LaTeX は非常に強力なツールであり、科学/数学の文献用に設計されているため、ここではやり過ぎかもしれません。それは(比較的)急な学習曲線を持っており、あなたがそれに慣れていない場合、あなたが望むように正確に行うのは難しいかもしれません. 私は LaTeX が大好きですが、実際には汎用のワープロではありません。

代わりに OpenOffice を検討しましたか?

于 2009-05-14T09:05:09.620 に答える
3

LaTeXは、ドキュメントを作成する必要がある場合、非常に強力な言語です。

おそらく、クロスプラットフォームのLaTeXエディターであるtexmakerを試すことができます。

Texmakerは、優れたホットキーサポートと広範なLaTeXドキュメントを備えた、クリーンで高度に構成可能なLaTeXエディターです。Texmakerは、ドキュメントの開発に必要な多くのツールをLaTeXと1つのアプリケーションに統合します。構文の強調表示、ワンクリックでの370の数学記号の挿入、ナビゲーションを容易にするためのドキュメントの「構造ビュー」など、いくつかの優れた機能があります。

于 2009-05-15T08:34:42.493 に答える
2

実際のコードを文書化することについて話しているのですか? そうであれば、アンマネージド コードにはDoxygenを、マネージド コードにはSandcastleをお勧めします。どちらも、ヘルプをコンパイルするか、Web サイトとして構築します。

どちらのアプリケーションも、関数 / クラス / 変数の上の特別なタグを読み取り、それをヘルプにコンパイルします。

于 2009-05-14T09:07:33.903 に答える
2

HTML を使用するとどうなりますか? 多くの人が多くの場所からアクセスする必要がある場合、この方法でドキュメントを公開できます。

于 2009-05-14T09:02:50.157 に答える
2

あらゆる努力と妥当な期待にもかかわらず、ワープロはまだ「解決」されていないと思います。

私が個人的に MS Word で非常に苛立たしい経験をしていることに対する私の反応は、それを完全に回避し、GhostDocのような自動文書化ツールを使用して、既にコードに記述したものからXMLを生成し(DRY!)、それに対処することです。 XSLT ベースのイントラネット サイトなどからの XML。

于 2009-05-14T09:06:19.523 に答える
2

私は wiki を検討しましたが、Markdown は HTML にレンダリングできる一方で、Wiki のコンテンツを Wiki 自体の外に簡単にエクスポートして配布することはできないという単純な理由から、変更された Markdown 表記法を使用することにしました。

私のワークフローに関する chris の質問への回答:私はメモ帳のようなアプリケーション ( TextWrangler、ワードラップ機能のためだけ) を使用してドキュメントを生の Markdown 形式で書いています。次に、ドキュメント ファイルのタイムスタンプをチェックする、変更された Markdown パーサー(いくつかの機能ともう少し HTML 指向の機能用に拡張されたもの) を備えた小さなローカルホスト ドキュメント Web サイトがあります。ファイルが更新されている場合は、そのファイルを解析しHTML、およびファイルをキャッシュに保存します。

このようにして、デスクトップでソース ドキュメントを編集し、ブラウザで F5 を押すだけで結果をすぐに確認できます。

于 2009-05-14T09:18:35.670 に答える
2

そもそも、MS-Word に問題があることを発見したことは一度もありません。(つまり、時間をかけて効果的に使用する方法を知る場合). OpenOfficeは確かに驚くほど信頼できる無料の代替手段ですが、レイアウト関連の問題で MS Word が嫌いな場合は、OpenOffice でも同じ問題が発生します。

自分でラテックスシステムを試したことはありませんが、科学的な作業に適していると聞いたことがあります。コンテンツだけに集中したい場合は、HTML WYSIWYG エディターを使用するのが最適だと思います。

于 2009-05-14T09:23:49.840 に答える
1

LaTeXよりもシンプルなものが必要な場合は、ReStructuredTextをご覧ください。

于 2009-07-28T07:53:15.483 に答える
1

まだ試してませんが、AsciiDocはこの種の作業に適しているといつも思っていました。

于 2009-05-15T09:40:01.447 に答える
0

簡単な答え:LaTeXはまさにあなたが探しているもののように聞こえます。

私は自分でドキュメントを書くためにそれを使用します。オプションがあれば、Wordに戻ることはありません。

于 2009-05-15T08:42:47.467 に答える
0

phcでは、latexから始めて、docbookに移行し、Restructured Text / Sphinxに落ち着きました(永続的に私は願っています)。

ラテックスが選ばれたのは、私たちが学者であり、ラテックスが最適なツールだからです。十分なHTMLが生成されなかったと思います。

Docbookは権力のために選ばれましたが、それは非常に扱いにくいものでした。ドキュメントの作成を延期しました。コードは手動でフォーマットする必要があり、構文を忘れ続け、読みづらくなりました。学習曲線も急でした。

最後に、スフィンクスを使用してreSTに移行しましたが、これはすばらしい決断でした。ドキュメントの作成が非常に簡単になり、PDFバージョンとHTMLバージョンの両方が美しく見えます(ただし、PDFはいくつかのカスタマイズで行うことができます)。カスタマイズも非常に簡単です。

ただし、reSTの最も優れている点は、人間がソース形式で読み取れることです。それは素晴らしい利点です。私は今、すべてのもの、特にWeb上のすべてのものにreSTを使用するように切り替えました(もちろん、ラテックス以外のものを使用するのは愚かである学術論文を除く)。

于 2009-09-11T12:17:01.867 に答える
0

http://www.doxygen.nl/でdoxygen を調べてみてください。彼らの素敵な例を見てください。この場合、ドキュメントはソース内のコメント内のタグによって表示されます。

もう 1 つのオプションは、 http: //trac.edgewall.org/ のtrac のようなオンライン システムを使用することです。これは、subversion の上にある wiki/doc/issuetracking システムです。

于 2009-05-14T09:13:44.777 に答える
0

私は、単語よりもはるかに扱いにくい RTF エディターを使用することを好みます。このようにして、書式設定とすべてのヘッダー/フッターのナンセンスに時間の半分が費やされることはありません。ワードパッドは、何度か私のために働いてきました。私は今のところWordで立ち往生しています:(

于 2009-05-14T09:14:03.437 に答える
0

この本を読んでください: http://en.wikipedia.org/wiki/The_Pragmatic_Programmer . ドキュメントが自動的に構築されるように、いくつかのアイデア修正が内部にあります。これに IDE を使用することを検討するか、追加のツールを探してください。最新の言語のほとんどは、コードを記述しながらドキュメントを生成することをサポートしています。これにより、コードの最新の変更に合わせてドキュメントを簡単に維持できます。

于 2009-05-14T09:05:16.890 に答える
0

可能な方法はたくさんあります:

  • javadoc などの埋め込みドキュメント: API の説明には適していますが、「全体像」にはあまり適していません。
  • プレーンな html: バージョン管理下でチェックインでき、明確な利点があります。
  • confluence などの Wiki -- 共同作業には最適ですが、ソースとはバージョン管理が異なります
  • LaTeX など: 通常のドキュメントよりも本や論文に適しています。グラフィックスのサポートは面倒です
  • OpenOffice などの Office クローン: Word + Visio とほぼ同じですが、オープン ソースであり、より優れたドキュメント形式を備えています。

私は通常、Visio を使用して、ソフトウェア構造 (プロジェクトの「比喩」、コンポーネントの相互関係、外部システム) を「自由形式」の UML で文書化します。これらは合流点に埋め込まれ、印刷物が必要な場合は PDF に変換できます。

于 2009-05-14T09:14:39.347 に答える
0

リュクス

LyXは、LaTeX のWYSIWYMフロント エンドです。LaTeX の一貫性とパワーを備えたドキュメント プロセッサ (Word に多少似ています) の利便性が得られます。邪魔にならず、プロのライターが必要とする多くのことを実行できます。 .

注:あなたの正解は、あなたの考え方によって異なります。この回答は、ドキュメントをドキュメントと考え、Word (Word が優れている) に似たものが必要で、Word (Word はプログラマーに適していない) のようにうまくいかない場合に最適な選択肢を示しています。

しかし、多くのプログラマーはドキュメントの考え方が異なるため、異なるメタファーを好みます。私自身、何年も前に同じ問題を抱えており、(私は数学者なので) LaTeX で作業し、LyX を見つけ、最終的に自分で作成した Wiki/Source システムに落ち着きました。

于 2009-05-14T09:38:56.323 に答える
0

Vim は、可能な限り最も効率的な方法でプレーン テキストを記述することを意味するすべてのソリューションです。書式設定が必要な場合は、XML、Latex、または同様のものを (Vim で) 使用します。

Vimが私の人生を変えました!

于 2009-05-14T09:39:55.417 に答える