What kind to documents should i write for Java project?

I was recently asked how to start documentating for a Banking solution which is been developed in Java on Open-Source platform. What kind to documents should i write for this project? Now, there isn't much to go on here, so... It depends on what the client actually wants. Here's what I'd do: 1. Ask the person in charge which activities are most important, for example, installing the servers, updating the databases, teaching users and so on. 2. Once you have a list of the most essential activities, discuss with him/her what you believe are most necessary... 3. then you can write books that support these tasks, Without knowing too much else about the project, I'd say that you need to produce: Admin Guides User Guides Release Notes Training Documents Installation Guides If you let me know more abour the project, I can give you more concrete answers.

Endless Sources of Free Content

We've been researching material that has entered the public domain recently. These books are all 'copyright free'. What does this means to me as a Webmaster? As the copyrights for all of these books have expired, you can do whatever you like to them. Publish them on your site, use for online courses, give them away as free gifts. It's up to you. For books that you can use for free content, look at: http://www.ibiblio.org/ http://www.readprint.com/ http://www.bartleby.com/ http://www.gutenberg.com/ Gutenberg is my favourite. Download the books as PDF, html or as plain unformatted text. PS - Let me know of a good site that offers free public domain material and I'll add it to the list. Regards, Ivan

How to Write a Great Case Study

Case Studies can be a very effective promotional tool. Next to White Papers, they are the second most popular device used to promote the benefits of a product or service. With that in mind, if you’ve been commissioned to write a case study or are new to this area, this backgrounder might help. So, what is a Case Study? A case study demonstrates how a specific situation was initially identified, which solution was selected to resolve the issue, and a summary of the final results. In the IT world, case studies tend to be short; somewhere between 300-500 words. In general, aim for three pages, and include one graphic per page at most. Anything more and it looks like ‘hard sell’; case studies typically adopt a ‘soft-sell’ approach. How to structure your case study There are three sections to a case study. 1. Problem 2. Implementation 3. Results The opening 'problem' section must carry a punch. In other words, it has to mean something to the reader – something that they can relate to. Always write about an issue that has significant business impact for the reader. Demonstrate how your product resolved a critical business issue—what you’re implying in this section is that if they choose your service, you can also resolve their issues... Indeed, the more specific the case study, the more effective it will be. Case Studies that propose to ‘solve all problems’ are not taken seriously. Highlight the Benefits Instead, concentrate on how the solution, or service, addresses a very specific issue. Be very careful here, as the entire case study is built around this single issue. Don’t dilute the case study by addressing more the one issue – stick to one area and explain how you can solve the problem in measurable and quantifiable terms. For example: Support your case study with statistics, figures and tables where appropriate. Return On Investment — explain how the investment in your product/service pays for itself. For example, it increases productivity by 50% within 2 months. Demonstrate how you can substantiate this; otherwise, your argument loses credibility. Cost Containment – how does the solution help contain costs? This area is very important, as budgets are always a sensitive issue. If you can illustrate how a similar company saved a certain amount of money by adopting your product—i.e. real proof—you'll certainly captures the reader's attention. Reducing Barriers — demonstrate how your solution improves operations. For example, how does it fit into their business process? This is a good area to mention how your system plugs into other applications or expensive business critical applications. Use your judgment when compiling the final case study document. Avoid making it too technical or overloading it with excessive statistics. Make the statistics stand out so that the reader can easily digest them — and then remember them later on. Long Term Rewards Impressive case studies stand out; decision-makers will use them as a source of reference and cite you as a credible, trustworthy and reliable source of information — the type of company people want to do business with. PS: Include a benefit in the title of your case study. Instead of writing “Aerospace Case Study”, say “Case study on How Product X Improved Sales by 300%”. Grab their attention from the start — and then keep it! Did you know? You are welcome to republish this article on your site, newsletter or magazine, once you've placed the following text and link at the end of the article: Ivan Walsh, who runs www.Klariti.com, specializes in Professional Writing Services. Read more about Case Studies at http://www.klariti.com/business-writing/index.shtml

Microsoft to partner with eBay, Equifax and PayPal

Hi Folks, Those of you who run a small business with MS Office - and use Paypal for web payments - might be interested in this press release from MS and Paypal. Microsoft is to link up with eBay Inc., Equifax and PayPal to offer online integrated services for Microsoft Office Small Business Accounting 2007. "We have talked to small businesses, and, not surprisingly, the No. 1 concern they have is the amount of time they spend on financial management," said Rajat Taneja, GM of small business product development at Microsoft. Microsoft worked closely with eBay through the eBay Developers Program to enable Office Small Business Accounting 2007 users to list and sell items on eBay from within their accounting software. Chris Tsakalakis, VP of advanced solutions at eBay said, "The eBay listing feature included in Microsoft's new accounting software will empower small businesses to explore new revenue channels, while offering current eBay sellers a complete small-business accounting solution to help them grow their businesses." eBay - Office Small Business Accounting 2007 will enable small businesses to easily sell their products on eBay, made possible through eBay's Web Services API. The upcoming product provides businesses with the ability to select products from their inventory, list items for sale on eBay, view status of listings, and download transactions and fees -- all from within the accounting software. Equifax - Businesses will be able to monitor the credit-worthiness of their customers, their vendors and their own business on an ongoing basis directly from within the accounting software. PayPal - Working with PayPal, Microsoft will provide Invoice Payment Service and Merchant Processing Service, both within Office Small Business Accounting 2007. These services will enable small businesses to accept payment transactions with PayPal, either through e-mail or through direct credit card payments. These solutions will save small businesses time and money and result in greater payment flexibility for their customers. MS Office Small Business Accounting 2007 will include the following: -- Enhanced Integration with Microsoft Office Outlook 2007 with Business Contact Manager will let you share and update a single list of customers across the organization. -- Multicurrency support. Small businesses will be able to add or change information about the foreign currencies and easily update exchange rates. More information at http://office.microsoft.com/en-us/FX011956881033.aspx Ivan

Dont Cut and Paste from Word into Blogger

If you’re writing your blog in Microsoft Word and you use an apostrophe, for example can’t, and then cut and paste it into Blogger, it is possible that Blogger will not be able to convert the apostrophe. Instead you will get [] characters. Here's a quick trick. Open Notepad and copy the blog from Word into Notepad. Then, copy from Notepad into Blogger. PS - also be careful if you use semi-colons and colons. Other Tip: watch out if you send your post to Blogger via Yahoo or Hotmail as they will include an ad in the footer of the email. Ivan Walsh

What's the Best Font for Web Writing?

Hi Folks, I was brought up to believe that Times New Roman was THE font for printed manuals. They're was no ifs, buts, or maybes about this - Times New Roman and make it size 11. But what's the best font for writing on the web? Look at the different fonts used on the CNN, Yahoo and Guardian sites. All similar, but different. Some use Serif and other Sans-Serif. Serif are those with feet like Times Roman, while those without (i.e. sans) serif include Verdana, Arial and the like. We use Verdana on our www.klariti.com site, which I think is very readable. But 'experts' have told me that this is dated and not 'user-friendly'. They suggested Garamond. What do you think? Let me know of any sites you think are getting it right. And maybe some that are a nightmare to read. Thanks Ivan

Free Cartoons for your Blog

You can add this cartoon to your blog, subject to one or two very basic conditions. Cartoon by Dave Walker. Find more cartoons you can freely re-use on your blog at We Blog Cartoons. FAQs from Dave's site "Is it free to re-use all your cartoons? In a blog, yes. In any other sort of publication, no. Why are you letting us use your cartoons for free? The more people that enjoy my work the better and life is generally too short not to give things away." More FAQs at http://www.weblogcartoons.com/faqs/

Web-based training on FrameMaker

"My job involves writing and editing documents. I also coordinate with the graphic designer for layout and look and feel. Can you please let me know details about training for FrameMaker?" Apologies for the delay - I couldn't find the link I wanted to send to you. Here it is: http://apex.vtc.com/framemaker-7.php Regards, Ivan PS - Stop Writing Sales Letters The Hard Way! "Within a week of signing-up for the "Instant Sales Letter" I received two $339.95 orders for my home business development system. That's with no personal contact at all. The things that I learned from the techniques and templates contained in your sales writing e-book have already paid for itself 13 times over! So far, your program has been everything you say it is and more." Raymond M. DeGrendel, Oscoda, MI" Check out =====> http://www.instantsalesletters.com/?44848

Best Template for Writing Case Studies

We got an email today regarding the best template for writing case studies. Here's a few pointers: 1. who do you expect to read this? Is it journalists, motorcycle enthusiasts, or those coming from a technical capacity, such as designers. 2. where will they read it? If they will read it on the web, then use less graphics and more text. Consider any possible bandwidth issues they may have. 3. will they print it out? If so, remember to include your physical address and low-call telephone numbers. Actually, I'd strongly suggest that you encourage your reader to print your sales collateral whenever possible. If it looks good, and I'm sure it does, then it will reflect positively (ie on your core brand values) whenever someone sees it one a meeting table, in a convention foyer, or in a media pack. With that said, you might want to look at Case Study 3 Pack we offer at: http://www.klariti.com/templates/Case-Study-Template.shtml This includes screenshots of all the templates so you can see what your getting in advance. PS - You may also want to look at the White Paper template pack. Many of our customers seem to prefer their look and feel, especially the black and red designs. http://www.klariti.com/templates/White-Paper-Template.shtml Again, we have screenshots so you can so what's on offers. PPS: I'd be delighted to proof your case studies before you publish them. I offer this service to all new customers to get them up and running. There is no cost involved and maybe we all learn something in the process. That's it. Regards, Ivan Walsh General Manager Klariti Business Documents