textlint · The pluggable linting tool for text and markdowntextlint is an open source text linting utility written in JavaScript. It is hard to lint natural language texts, but we try to resolve this issue by pluggable approach.
RedPen ã¦ã‚™ã‚ã‹ã‚Šã‚„ã™ã„技術文書を書ã“ㆠ| DevelopersIO
最近ã¯ãƒ–ãƒã‚°ã‚’始ã‚マニュアルや仕様書ãªã©æŠ€è¡“文書を書ã機会ãŒå¤šããªã£ã¦ãã¾ã—ãŸã€‚ 技術文書ã¯ã‚ã‹ã‚Šã‚„ã™ã•ãŒé‡è¦ã ã¨æ€ã†ã®ã§ã™ãŒå®Ÿéš›ã¯æ›¸ã‘ã¦ã„ã¾ã›ã‚“。 ã©ã†ã—ãŸã‚‰ã‚ã‹ã‚Šã‚„ã™ã„文書ãŒæ›¸ã‘ã‚‹ã®ã ã‚ã†ã‹ï¼Ÿã¨èª¿ã¹ã¦ã„ãŸã‚‰ RedPen ã¨ã„ã†ãƒ„ールを見ã¤ã‘ãŸã®ã§æ—©é€Ÿè©¦ã—ã¦ã¿ã¾ã—ãŸã€‚ RedPen ã¨ã¯ï¼Ÿ RedPen ã¨ã¯ãƒ—ãƒã‚°ãƒ©ãƒžã‚„記者ãŒè¦ç´„ã«å¾“ã£ã¦æ–‡æ›¸ã‚’記述ã™ã‚‹ã®ã‚’サãƒãƒ¼ãƒˆã—ã¦ãれるオープンソースã®ã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ãƒ„ールã§ã™ã€‚ プãƒã‚°ãƒ©ãƒŸãƒ³ã‚°ãŒè¦ç´„ã«å¾“ã£ã¦ã‚³ãƒ¼ãƒ‡ã‚£ãƒ³ã‚°ã•ã‚Œã¦ã„ã‚‹ã‹ãƒã‚§ãƒƒã‚¯ã™ã‚‹ã‚ˆã†ã«ã€RedPen ã¯è‡ªç„¶è¨€èªžã§è¨˜è¿°ã•ã‚ŒãŸå…¥åŠ›æ–‡æ›¸ã®æ¤œæŸ»ã‚’自動化ã—ã¦ãã‚Œã¾ã™ã€‚ RedPen ã®ç‰¹å¾´ è¨å®šãŒæŸ”軟ã«è¡Œãˆã¾ã™ã€‚（カスタマイズも柔軟） ã©ã®ã‚ˆã†ãªè¨€èªžã§æ›¸ã‹ã‚ŒãŸæ–‡æ›¸ã§ã‚‚処ç†ã§ãã¾ã™ã€‚（もã¡ã‚ん日本語も OK ã§ã™ï¼‰ Markdown ã‚„ Textile フォーマットã§è¨˜è¿°ã•ã‚ŒãŸæ–‡æ›¸ã‚’ãã®ã¾ã¾æ¤œæŸ»ã§ã
phpDocumentor - PHPDocã«ä»£ã‚ã‚‹APIドã‚ュメント自動生æˆãƒ„ール - Do You PHP?
ãšã„ã¶ã‚“å‰ã«PHPDocã‚’å–り上ã’ã¦ã‚ã‚Œã“れ触ã£ã¦ã¿ã¾ã—ãŸãŒã€ã„ã¤ã®é–“ã«ã‹PEARマニュアルã‹ã‚‰ãƒšãƒ¼ã‚¸ãŒãªããªã£ã¦ã„ã¾ã—ãŸã€‚ç¾åœ¨ã§ã¯PHPDocã®ä»£ã‚ã‚Šã«ã€é«˜æ©Ÿèƒ½ãªphpDocumentorãŒPEARã«è¿½åŠ ã•ã‚Œã¦ã„ã¾ã™ã€‚ phpDocumentor本家 PEARマニュアルã®phpDocumentorã®ãƒšãƒ¼ã‚¸ 基本的ã«ã¯PHPDocã¨åŒã˜ã€ŒAPIドã‚ュメントを自動生æˆã™ã‚‹ã€ã¨ã„ã†æ©Ÿèƒ½ã ã‘ãªã®ã§ã™ãŒå‡ºåŠ›å½¢å¼ãŒå¤šæ§˜ã§ã€HTMLã ã‘ã§ã‚‚デザインテンプレートãŒä½•ç¨®é¡žã‚‚用æ„ã•ã‚Œã¦ãŠã‚Šã€pear.php.netã«ã‚ã‚‹APIドã‚ュメントã§ã‚‚採用ã•ã‚Œã¦ã„ã¾ã™ã€‚HTML以外ã«ã‚‚PDFå½¢å¼ã‚„Windowsã®ãƒ˜ãƒ«ãƒ—ファイル用hhpファイル（別途コンパイルãŒå¿…è¦ï¼‰ã€ã¯ãŸã¾ãŸpeardoc用docbookも出力ã§ãã¦ã—ã¾ã„ã¾ã™ã€‚ 今回ã¯ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã‹ã‚‰ã–ã£ã¨ã—ãŸä½¿ã„æ–¹ã¾ã§ã‚„ã£ã¦ã¿ã¾ã—ãŸã€‚ ã¾ãšã¯ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã§ã™ã€‚ãŠæ±º
仮想パãƒãƒ«ï¼šã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ã‚¢ãƒ¼ã‚テクãƒãƒ£ã®æ–‡æ›¸åŒ–ã«ã¤ã„ã¦
原文(投稿日：2009/08/10)ã¸ã®ãƒªãƒ³ã‚¯ ソフトウェアアーã‚テクãƒãƒ£ã®æ–‡æ›¸åŒ–ã¨ã„ã†ã®ã¯ã€ä¼æ¥ã®ã‚¢ãƒ—リケーション開発プãƒã‚»ã‚¹ã«ãŠã„ã¦é‡è¦ã§ã‚る。プãƒã‚¸ã‚§ã‚¯ãƒˆã«ãŠã‘るアーã‚テクãƒãƒ£ã®æ–‡æ›¸åŒ–ã®ãƒ‹ãƒ¼ã‚ºã‚’ç†è§£ã™ã‚‹ä¸Šã§é‡è¦ãªã“ã¨ã¯ã€ã‚¢ãƒ¼ã‚テクãƒãƒ£ã®æ–‡æ›¸åŒ–ãŒãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆã®ãƒ©ã‚¤ãƒ•ã‚µã‚¤ã‚¯ãƒ«ã«ãŠã„ã¦ã©ã‚“ãªå½¹å‰²ã‚’æžœãŸã™ã®ã‹ç†è§£ã™ã‚‹ã“ã¨ã 。プãƒã‚¸ã‚§ã‚¯ãƒˆã«ãŠã„ã¦ã€ã‚¢ãƒ¼ã‚テクãƒãƒ£ãƒ‰ã‚ュメントを作æˆã™ã‚‹æ ¹æœ¬çš„ãªç†ç”±ã¯ã€ã‚³ãƒŸãƒ¥ãƒ‹ã‚±ãƒ¼ã‚·ãƒ§ãƒ³ã¨åˆ†æžã¨è¨˜éŒ²ã®ãŸã‚ã§ã‚る（例ãˆã°ã€ã‚る決定をドã‚ュメントã«è¨˜éŒ²ã—ã¦ãŠãã¨ã€æ™‚é–“ãŒçµŒéŽã—ã¦ã‚‚失ã‚れるã“ã¨ã¯ãªã„）。プãƒã‚¸ã‚§ã‚¯ãƒˆã§ä½œæˆã™ã‚‹ã‚¢ãƒ¼ã‚テクãƒãƒ£ãƒ‰ã‚ュメントã®é‡ã¨ç¨®é¡žã¯ã€ãã®ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆã§ä½œæˆã™ã‚‹ãƒ—ãƒãƒ€ã‚¯ãƒˆã®ã‚³ãƒŸãƒ¥ãƒ‹ã‚±ãƒ¼ã‚·ãƒ§ãƒ³ãŠã‚ˆã³åˆ†æžã®ãƒ‹ãƒ¼ã‚ºã‚’åæ˜ ã—ãŸã‚‚ã®ã«ã™ã‚‹ã¹ãã§ã‚る。 アーã‚テクãƒãƒ£ãƒ‰ã‚ュメントã¯ã€ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆã‹ã‚‰ãƒžãƒã‚¸ãƒ¡ãƒ³ãƒˆã¸ã€ã‚¢ãƒ¼ã‚テクトや主任è¨è¨ˆè€…ã‹ã‚‰é–‹ç™ºè€…ã¸ã€ãƒ—
Lean/Agile Documentation: Strategies for Agile Teams
Lean/Agile Documentation: Strategies for Agile Teams Agile documentation, also referred to as lean documentation, is concise and sufficient for the needs of its readers. When I initially started work on Agile Modeling (AM) I wanted to focus solely on principles and practices for effective modeling but quickly discovered that this scope was not sufficient, that I also needed to consider the issue o
1
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
{{#tags}}- {{label}}
{{/tags}}