firebird-docs

[Firebird-docs] Migration from MS SQL Server

[Marcelo L. R. <mar...@xl...>]

I have some experience with MS SQL Server, so maybe I could write the =
"Converting Microsoft SQL Server databases to InterBase" topic. It =
should probably be Firebird rather than InterBase, by the way, but =
that's the way it's listed on the IDBH outline.

Are there any writing guidelines, for example, on:
- writing style (first/third person? formal/informal? conversational?)
- structure
- acronyms (do we spell them out the first time in each section? never?)
- how experienced we assume the reader is

I realize enforcing a consistent writing style when many different =
authors are involved is next to impossible, but I think it's a good =
thing to consider.

Then again, I've never written anything that got published in my life, =
so what do I know?

Is the MSSQL migration topic taken, or are there any suggestions for =
something more important to work with first?

Marcelo Lopez Ruiz

Re: [Firebird-docs] Migration from MS SQL Server

[Jeff D. <je...@el...>]

  I say write whatever you can in any style you can.  It can all be editted
and corrected and tweeked for style later.  Your idea for a topic is
excellent.  I've started to work on Migration a little, but not specific to
MSSQL.  I think we should have a migration section for every major database
eventually.
  Right now I'm working on an explanation of Firebird datatypes and
explaining what they will take in the way of data, for example.  Firebird
has no Boolean datatype so someone porting to it needs to know how to make
one as a domain etc.  After basic issues I'm going to move on to conversion
from older Interbase versions.

  IMHO migration from MSSQL documention would be very important, as it is a
widely used database.  If Firebird can grab some marketshare from Microsoft
maybe we can get some corporate sponsoring for the Code Developers.  If we
are to get people to switch from MSSQL to Firebird they need the docs on how
to do it and what issues they will encounter.  Roles could be a hotpoint
here.

As I said before any work you can do on any subject, in any format, would be
greatly appreciated by everyone.

Jeff Dodds
""Marcelo Lopez Ruiz"" <mar...@xl...> wrote in message
news:007d01c0d3de$a83267d0$80f900c8@marcelont...
> This is a multi-part message in MIME format.
>
> ------=_NextPart_000_007A_01C0D3C5.82B8EFB0
> Content-Type: text/plain;
> charset="iso-8859-1"
> Content-Transfer-Encoding: quoted-printable
>
> I have some experience with MS SQL Server, so maybe I could write the =
> "Converting Microsoft SQL Server databases to InterBase" topic. It =
> should probably be Firebird rather than InterBase, by the way, but =
> that's the way it's listed on the IDBH outline.
>
> Are there any writing guidelines, for example, on:
> - writing style (first/third person? formal/informal? conversational?)
> - structure
> - acronyms (do we spell them out the first time in each section? never?)
> - how experienced we assume the reader is
>
> I realize enforcing a consistent writing style when many different =
> authors are involved is next to impossible, but I think it's a good =
> thing to consider.
>
> Then again, I've never written anything that got published in my life, =
> so what do I know?
>
> Is the MSSQL migration topic taken, or are there any suggestions for =
> something more important to work with first?
>
> Marcelo Lopez Ruiz
>

Re: [Firebird-docs] Migration from MS SQL Server

[reed m. <rf...@cr...>]

Marcelo,
for some reason, you post shows up in the netscape newsreader
with no visible content (I'm subscribed to the 
sourceforge.firebird-docs newsgroup at news.atkin.com)

Using "View page source" shows a multi-part mime like this:
> ------=_NextPart_000_007A_01C0D3C5.82B8EFB0
> Content-Type: text/plain;
>        charset="iso-8859-1"
> Content-Transfer-Encoding: quoted-printable
>
> I have some experience with MS SQL Server, so maybe I could write the =
[...and this...]
> ------=_NextPart_000_007A_01C0D3C5.82B8EFB0
> Content-Type: text/html;
>         charset="iso-8859-1"
> Content-Transfer-Encoding: quoted-printable
> 
> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
[...]

I don't know if this is a problem on your end or mine,
but I thought I'd let you know.

[...]
> Are there any writing guidelines, for example, on:
> - writing style (first/third person? formal/informal? conversational?)
I agree with jeff, what you are comfortable with. I would think
it should be semi formal. A little conversational if it makes
it easier to read.

> - structure
Hmmm... I think you'll have to play with this after you
have much of the content written.
> - acronyms (do we spell them out the first time in each section? never?)
First time in a section would be ok. It might be better to use a glossary
(which could be shared between all the docs, if the tools permit).

> - how experienced we assume the reader is
> 
I would say, assume that they have basic knowledge of SQL
server, SQL databases in general and OS administration. Assume
minimal knowledge of firebird/interbase, but rather than describing
each interbase operation in detail, refer the reader to where they can
get more information on that topic. (e.g., if you talk about creating a
database and some domains, say that "data definition is described in such
and such document...")
If the document you need to refer to doesn't exist, I'd say
just make a note of it for now.

> I realize enforcing a consistent writing style when many different =
> authors are involved is next to impossible, but I think it's a good =
> thing to consider.
> 
[...]
--
Reed Mideke
email: rfm(at)cruzers.com  -If that fails:  rfm(at)portalofevil.com