background preloader

Natural Docs

Natural Docs

Timmon - Time Monitor NDoc Online wtfjs dartdocgen: The API Documentation Generator Use dartdocgen to generate, and serve, the documentation for your Dart package. Basic usage Dartdocgen generates documentation from Dart code in the lib directory and creates the output in JSON format. When using the --serve option, dartdocgen serves your files so you can see them locally in a browser. To deploy your documentation to the web, host the viewer on your server, compiled to JavaScript, along with your generated files. Generate documentation Here is a simple example of using dartdocgen to generate docs on the command line. Run this command from the top-level directory of your Dart package, after you have run pub get to get the dependencies: dartdocgen . This command generates documentation, in the JSON file format, and places it in a top-level directory named docs. View docs locally Here is a simple example of using dartdocgen to generate, and then serve, the generated docs to the viewer. dartdocgen --serve . Deploy docs To deploy your documentation to the web, do the following:

Xuse - Aivosto - Analyze, Document and Flowchart Source Code Yahoo! Friday, September 17th, 2010 Progressive enhancement using nothing but JavaScript? Progressive enhancement is still a confusing matter for a lot of people who are very excited about the capabilities of JavaScript in modern browser environments. It can feel anachronistic to write your solutions for a non-JS environment and then once more enhances in JavaScript. Wednesday, August 11th, 2010 Free talk at Yahoo on the 27th about the software revolution that is JavaScript Yahoo invites to their campus in Sunnyvale, California on the 27th of August to hear Douglas Crockford talk about “Loopage”. Friday, January 29th, 2010 Addmap.js – automatically analyse a text for geo locations and add a map As part of an upcoming article on geo location I am putting together a few Geo Toys for myself and here is the first one. Monday, January 11th, 2010 Using YQL as a proxy for cross-domain Ajax OK, this is nothing shockingly new, but I found it pretty useful. Tuesday, January 5th, 2010 YUI 3 Is Out! - Getting Started AurigaDoc Comparison of documentation generators - Wikipedia, the free enc The following tables compare general and technical information for a number of documentation generators. Please see the individual products' articles for further information. Unless otherwise specified in footnotes, comparisons are based on the stable versions without any add-ons, extensions or external programs. General information[edit] Basic general information about the generators: creator/company, license/price etc. Operating system support[edit] The operating systems the generators can run on. Note (4): GNU D Compiler. Language support[edit] The programming languages the generators recognize. Note (1): .NET is not a programming language, but is listed here for convenience. Note (2): Though not supported as a native input language, Doxygen can be extended through the use of filters. Note (3): Generators listed here can be extended to support any language that has comments. Input formats[edit] The input formats the generators can read. Output formats[edit] Other features[edit] GhostDoc

IEBlog : IE JavaScript Performance Recommendations Part 2: JavaScript Code Inefficiencies Hello again, this is Peter Gurevich, Performance PM for IE. We have gotten a lot of good feedback from our first post on IE + JavaScript Performance Recommendations so I am eager to hear what you think of our second installment. This is the first of two posts concerning inefficiencies in Javascript code itself. JScript Code Inefficiencies – Chapter One There are plenty of ways to use JScript (and other Javascript engines) inefficiently since the interpreter performs almost zero optimizations when interpreting code. Optimize String Manipulations by Avoiding Intermediate Results Most JScript code used for manipulating the IE DOM requires some sort of string manipulation. The first piece of erroneous code comes in using the standard string concatenation operator + when working with strings. Performance articles often note this type of construct is slow. var myRatherLargeString = smallerStrings.join(‘’); Not only is the code simpler, but it is also much faster for this case. Thanks,

Documentation generator Document generation can be divided in several type of documents: Batch documents (all automated documents)Interactive documents (documents that can not be produced automatically)Text block correspondence (documents created based on pre-defined text blocks)Forms (forms for websites) You can place every type of document you come across in one of these categories. Writing Software Requirements Specifications Here’s the scenario: You’re finishing up your latest HTML Help project…no more late nights or weekends…back to a “normal” 50-hour work week. That’s when the development team lead strolls into your office and says she just got your manager’s okay for you to help the development team “put together the software requirements specifications template for the next major project.” “A what?” For technical writers who haven’t had the experience of designing software requirements specifications (SRSs, also known as software functional specifications or system specifications) templates or even writing SRSs, they might assume that being given the opportunity to do so is either a reward or punishment for something they did (or failed to do) on a previous project. This article will describe what the software requirements specifications document is and why it’s important, discuss how and why technical writers should be involved with them, and discuss the critical elements for writing an SRS. Conclusion