Re: [Arianne-devel] documentation: client-server communication

[Ulrich E. <doo...@kn...>]

On Saturday 05 January 2002 18:56, you wrote:
> > The following text is intended to be proof-read and integrated into the
> > documentation. I can think of at least two former mails that also
> > contained
> > things for a doc-base: the requirements on the Object-container and the
> > coding-guidelines.
>
> I have the code one ready on my other location, I will place that one on 10
> days.
Sorry, I really don't understand that sentence.


> > client-server-communication
> > =======================
>
> Ok, I have read it, I will add it as documentation for Arianne but:
> - It don't show the actual design
I know. There are lots of things in the middle between the Player and the 
Object that I left out. There are two things I wonder about, mostly because 
they influence this doc's fitness for inclusion in the doc-base:
a) Are there any logical errors in it ? This includes things that are not 
clearly explained, missing remarks that are necessary for understanding it.
b) Is the described desing worth approaching ? Are there any limits in this 
design that make it unusable, are there things that should be implemented 
differently? 

Please also keep in mind that this doc is the bare base and additional docs 
will detail or extend certain aspects (manipulating client-side cache by 
sending Action-messages, Authentication, putting another level of indirection 
between the client and the Object with the Manager-network in the Server)

> - It really conflict with existing documentation
Miguel, the existing docs are badly structured, have lots of holes, lots of 
errors and contradictions. In the past, I was saying 'there and there is a 
hole,error,whatever' in the docs and hoping for the original author to fix 
it. That didn't happen. Instead, it was replaced with a totally different 
document, that described just a bigger greater and more obfuscated design, 
but was just as well-written as the one before: just useful as personal notes 
for a developer, almost useless for the public.
 So, here I try to give something explicitly labeled as document (why not add 
a mail to the docs...) to
a) make public my thoughts and goals about the topic
b) demonstrate how docs should be structured
c) avoid hurting peoples feelings by just showing errors in their docs/code

>
> Also I would like to know when the implementation will begin, and who will
> be in charge of it, as if it is an inmediate thing, I won't fix the actual
> code, as a lot of it will need to be reworked.
>
The implementation of what I described ? I think it is mostly done, it just 
needs a bit of structure and cleanup.