lfnetwork.com mark read register faq members calendar

Thread: OJP Documentation Improvements Thread
Thread Tools Display Modes
Post a new thread. Add a reply to this thread. Indicate all threads in this forum as read. Subscribe to this forum. RSS feed: this forum RSS feed: all forums
Old 03-22-2007, 02:52 PM   #1
razorace
Impressive, Terran!
 
razorace's Avatar
 
Join Date: May 2002
Posts: 9,172
OJP Documentation Improvements Thread

I'm starting up this thread to get some feedback on how we can improve the OJP documentation to make it more user-friendly.

We're already in the process of converting everything to html, but beyond that I'm not sure what we should do.

One idea is to dramatically reducing the amount of information that is in the changelog. Should we condense the changelog so it only discusses mentions major new features and major fixes? What about the nitty gritty change details? Do people care about that stuff or should only coders know when I've changed the FP cost of kicks from 2 to 3?

What do you guys think?


---Jedi Guardian of the Newbie Questions
---Masters of the Force Team Leader / Creator
---Open Jedi Project Lead Moderator / Co-Founder
razorace is offline   you may: quote & reply,
Old 03-22-2007, 04:50 PM   #2
HamstrYODA
Rookie
 
Join Date: Mar 2007
Posts: 33
I think that changelog needs only major features and fixes what comes to older version. maybe every detail for newest version (what has changed from last version to new one) and major things for older versions. If it isn't too much work to remove all minor things from changelog when next version comes out. (i hope you understand what i mean, my english fails sometimes)

on the other hand, does it matter if there is all the information... I think most of people doesn't even open the changelog. People who read it are interested about it and may want to know every change.

bah. first i had idea but when i kept writing and thinking, now i dont know is it good idea
HamstrYODA is offline   you may: quote & reply,
Old 03-22-2007, 05:43 PM   #3
ensiform
The Stig
 
ensiform's Avatar
 
Join Date: Nov 2004
Location: Sawtooth Cauldron
Posts: 1,241
Current Game: Borderlands 2
I think we should have a text changelog like so for server:
http://linespeed.net/projects/etpub/...txt?format=txt
And client/ui:
http://linespeed.net/projects/etpub/...txt?format=txt

And an overall documentations like so:
http://linespeed.net/projects/etpub/...tml?format=raw

http://linespeed.net/projects/etpub/...tml?format=raw


iojamp project lead / coder
ensiform is offline   you may: quote & reply,
Old 03-23-2007, 01:03 AM   #4
Mantis01
Rookie
 
Mantis01's Avatar
 
Join Date: Aug 2006
Location: Japan
Posts: 34
Post

Quote:
Originally Posted by razorace
I'm starting up this thread to get some feedback on how we can improve the OJP documentation to make it more user-friendly.

We're already in the process of converting everything to html, but beyond that I'm not sure what we should do.

One idea is to dramatically reducing the amount of information that is in the changelog. Should we condense the changelog so it only discusses mentions major new features and major fixes? What about the nitty gritty change details? Do people care about that stuff or should only coders know when I've changed the FP cost of kicks from 2 to 3?

What do you guys think?
following are my opinion.

In high priority,
For novice users, our OJP document should include more clear difference from "original JKA" to "latest OJP".
(A present document has only latest changelog)
following proposal of elements,
- OJP concept
- Saber combat manual
- Experience system
- Mercenaries
- Source build manual
- ToDo(target in the future)

And of course, latest changelog is needed for veteran user.
I welcome web-based document.
It is necessary to always contain the latest specification in an online
document.

In low priority,
we should correspond to multi languages ??
Yes, I will prepare a Japanese document.

These are trifling opinion from me.


________________
Mantis
Mantis01 is offline   you may: quote & reply,
Old 03-23-2007, 07:03 AM   #5
Maxstate
I forgot.... what?
 
Maxstate's Avatar
 
Join Date: Aug 2004
Location: ;o ;p :eek:
Posts: 2,090
Quote:
Originally Posted by ensiform
I actually converted most of the OJP documentation to HTML the hard way and it looked something like that, but Razor didn't like it

I think Mantis has the right idea though, we need to state the differences between regular JKA and OJP clearly.

Maxstate is offline   you may: quote & reply,
Old 03-23-2007, 02:10 PM   #6
razorace
Impressive, Terran!
 
razorace's Avatar
 
Join Date: May 2002
Posts: 9,172
Quote:
I think Mantis has the right idea though, we need to state the differences between regular JKA and OJP clearly.
I'm open to suggestions. The current readme already covers the OJP concept in some detail, but it's apprenently too complicated or never read by users.


---Jedi Guardian of the Newbie Questions
---Masters of the Force Team Leader / Creator
---Open Jedi Project Lead Moderator / Co-Founder
razorace is offline   you may: quote & reply,
Old 03-23-2007, 03:49 PM   #7
madcatmach2
Rookie
 
madcatmach2's Avatar
 
Join Date: Nov 2005
Posts: 206
Quote:
Originally Posted by ensiform
that deffinetly git's my vote that and i love the kinks to skip right to the part i want like say the saber section for new people

madcatmach2 is offline   you may: quote & reply,
Old 03-24-2007, 05:18 AM   #8
Maxstate
I forgot.... what?
 
Maxstate's Avatar
 
Join Date: Aug 2004
Location: ;o ;p :eek:
Posts: 2,090
Quote:
Originally Posted by razorace
I'm open to suggestions. The current readme already covers the OJP concept in some detail, but it's apprenently too complicated or never read by users.
You just need to pull that American movie announcer thing:
This summer... The Open Jedi Project will rock the internets!
A completely new movielike sabersystem that features parrying, faking, riposting and power attacking, expanded Force powers that'll make you cream your pants, new gamemodes like Cooperation mode and much much more.




People just want a short description of a feature so they can decide if the mod is worth their download. When I was still modhunting for JKA I would cruise through www.jk3files.com and just shortly read the description, if it said things like ^^^^^ that I would download it in a second.

Maxstate is offline   you may: quote & reply,
Old 03-26-2007, 07:31 PM   #9
razorace
Impressive, Terran!
 
razorace's Avatar
 
Join Date: May 2002
Posts: 9,172
Got a WIP version of the new documentation on the repository. Check it out and see what you think.

Readme
Index

FYI, this is the latest repository version, so it will be updated as I work on it.

EDIT: Updated to FireFox compatible links.


---Jedi Guardian of the Newbie Questions
---Masters of the Force Team Leader / Creator
---Open Jedi Project Lead Moderator / Co-Founder

Last edited by razorace; 03-27-2007 at 06:25 PM.
razorace is offline   you may: quote & reply,
Old 03-27-2007, 05:51 PM   #10
ensiform
The Stig
 
ensiform's Avatar
 
Join Date: Nov 2004
Location: Sawtooth Cauldron
Posts: 1,241
Current Game: Borderlands 2
FYI:
Index
Readme


iojamp project lead / coder
ensiform is offline   you may: quote & reply,
Old 03-27-2007, 06:27 PM   #11
razorace
Impressive, Terran!
 
razorace's Avatar
 
Join Date: May 2002
Posts: 9,172
Ah, gotcha. Thanks Ensi.


---Jedi Guardian of the Newbie Questions
---Masters of the Force Team Leader / Creator
---Open Jedi Project Lead Moderator / Co-Founder
razorace is offline   you may: quote & reply,
Post a new thread. Add a reply to this thread. Indicate all threads in this forum as read. Subscribe to this forum. RSS feed: this forum RSS feed: all forums
Go Back   LucasForums > Network > JediKnight Series > Community > Hosted Forums > Open Jedi Project (OJP) > OJP Documentation Improvements Thread

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is Off
HTML code is Off

Forum Jump


All times are GMT -4. The time now is 04:50 AM.

LFNetwork, LLC ©2002-2011 - All rights reserved.
Powered by vBulletin®
Copyright ©2000 - 2014, Jelsoft Enterprises Ltd.