Menu
▾
▴
Re: [Firebird-docs] Migration from MS SQL Server
|
From: reed m. <rf...@cr...> - 2001-05-03 18:54:08
|
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 |
