New Users Manual Proposal

M Kulish

New Member
(Not sure exactly where to place this so I started here.)

Friends,
Much has been said about the need for an updated user manual, and for one that is current. I’d like to propose that we take advantage of the unique conditions present in the JAVAD community to produce just that. We are all here because we recognize not only the great technical advantages of the system but also the very supportive and collaborative environment between and among JAVAD and the users. The consistent technical development and advancement of such a system means that there is constant change and improvement. Another given is that preparing reliable documentation is a significant task. That is at least doubled with such a rapid development cycle.

The forum is a great place for discussion and we have all learned a lot by being here. It is not however, the best format for documentation. What I propose is a community supported and developer sponsored Javad Users Guide wiki that leverages the common resources, knowledge, and interest of the whole community to produce the best possible user documentation to support the best available GNSS equipment. I don’t think this should be a haphazard affair and I’ve provided an outline of what I think would make a great and usable tool and the advantages of the wiki for doing it in the attached PDF.

If you think there is merit in that (or have a better idea), please chime in.
Michael
 

Attachments

  • Online Users Guide Outline.pdf
    36.1 KB · Views: 365

John Troelstrup

Active Member
Michael,
Thank you so much for this proposal. This is exactly what I had in mind when I mentioned it.
I do hope the collective with the knowledge have the time to develop it.
Even if it takes time...
; )
 

Steve Douty

Well-Known Member
What a great start. I would like to think the JAVAD staff would take this start and also take the lead on setting this up. I am getting desperate for something like this. Thanks to Michael for starting the thread.

How do we encourage the next step?
 

Aaron S

Active Member
I think the idea of a user's manual in the form of a wiki is an excellent idea. I use similar instructional websites for other hobbies on a regular basis and it works great. As long as there's at least a little bit of oversight from "official" Javad experts, it's got a lot of potential. Wiki format can be sketchy, but such a site would be maintained by people who really care about educating users and are passionate about the equipment. Better than a periodically updated pdf manual also - this would be updated in real time.
 

Matt Johnson

Well-Known Member
5PLS
@Javad would need to comment on if anyone is working on updating the manual and in what format. I wrote the Quick Start Guide and portions of the User's Guide. Since then the responsibility of updating the manual has been given to Moscow.

I think a new manual in Microsoft Compiled HTML Help format is the best option. When I researched this HelpNDoc looked like the best program to generate it. Here is an example of what it would look like: HelpNDoc User Manual.
 

Zove

New Member
I'm reading this discussion and I remembered, maybe around 2008 I was send proposal, request from Javad support to make online help, manuals, etc., because at that time I was impressed by Manifold team help page. Clear, better now than never, just sad that such speeds of simple idea implementation :)
 

Aaron S

Active Member
I'm reading this discussion and I remembered, maybe around 2008 I was send proposal, request from Javad support to make online help, manuals, etc., because at that time I was impressed by Manifold team help page. Clear, better now than never, just sad that such speeds of simple idea implementation :)

That looks a lot like what I think Matt is suggesting. I prefer that format - it's like the classic Windows 3.1 help files, which were pretty great.
 

Sven

New Member
That looks a lot like what I think Matt is suggesting. I prefer that format - it's like the classic Windows 3.1 help files, which were pretty great.

This is ironic - I'm a Manifold user and i was watching this thread with the idea that I would see what developed and then suggest it to Manifold if it was better than what they have currently (not too hard in my opinion). I don't want to offend anyone but I've never liked the Manifold help format (nor the discussion forum format for that matter - no where near as good as the Javad forum format/software). To see why just try searching for a term such as "georeference" or similar using the built in search facility.
It turns out the best way to search the help is to use Google to search the site for you: e.g - "georeference" site:manifold.net/doc/mfd9/ - pretty crude I reckon.
I thought the software Matt was suggesting looked good although I only had a quick look.
 
Last edited:

Steve Douty

Well-Known Member
Michael started a great thread, and others added some thoughts and a path towards a solution. It appears that JAVAD isn't interested in an updated dynamic manual. I don't believe that is the truth. What can we do to encourage JAVAD to help us help them?
 

Steve Douty

Well-Known Member
Michael started a great thread, and others added some thoughts and a path towards a solution. It appears that JAVAD isn't interested in an updated dynamic manual. I don't believe that is the truth. What can we do to encourage JAVAD to help us help them?
The timing and tone of my post was ill timed based on the passing of Dr. Javad. At the time of my post, I had no idea that he and the organization were under stress that dwarfs my concerns about a manual. With respect - God's speed.
 

Steve Douty

Well-Known Member
I think we are all looking for guidance on how, and a place, to improve, create, and update a manual. Who can we coordinate with? This is a MUCH NEEDED project. How can the users and the JAVAD team work together to get something moving, started that will be organized and accepted by all of us?
 

Eugene Aksyonov

Well-Known Member
Steve, we suppose to have an online docs which will be available for review and suggestions to correct. Currently we are selecting the tool, which is covering our needs to generate manuals and quick start guides in printed, online, mobile forms.
I think we should keep one dedicated thread for Users Manuals and there have updates and related discussions.
Is it sounds good?
 
Top