Documentation sugestion

View: New views
13 Messages — Rating Filter:   Alert me  

Documentation sugestion

by PCS-Lists :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Hi Nathan,

What do you think about use wiki for primary source of documentation?
This way can made easy documentation collaboration and version control.

TIA

Re: Documentation sugestion

by Nathan Gray :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


On 25-May-08, at 9:37 AM, PCS-Lists wrote:

> What do you think about use wiki for primary source of documentation?
> This way can made easy documentation collaboration and version  
> control.

I might not understand.  The wiki (http://projecterp.org) is currently  
the primary source for most of the documentation, and I encourage all  
who have something to contribute to do so.  There are a few exceptions:

1.  News / Current Events
News is currently generated through sourceforge.net, and displayed via  
RSS feeds, so they are not editable on the wiki.

2.  Code
I'm terrible at regenerating the code documentation (via Doxygen),  
which doesn't fit in a wiki style format, so it tends to be out of date.

3.  User manuals
The manuals are released as PDFs.  Submissions and errata are accepted  
and incorporated.  Dean Hampton is currently working on bringing these  
into a wiki-style format for both collaboration and use as part of  
eGroupWare's Manual application.

Were you referring to one of these, or does that answer your question?

Nathan Gray
nathan at goarctic dot com


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Perp-developers mailing list
Perp-developers@...
https://lists.sourceforge.net/lists/listinfo/perp-developers

Re: Documentation sugestion

by PCS-Lists :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Hi Nathan,

I am talking about the manuals.
Forget PDF and lets put them in wiki.
I think it will be better for us.

What do you think?

TIA

Nathan Gray wrote:
On 25-May-08, at 9:37 AM, PCS-Lists wrote:

> What do you think about use wiki for primary source of documentation?
> This way can made easy documentation collaboration and version  
> control.

I might not understand.  The wiki (http://projecterp.org) is currently  
the primary source for most of the documentation, and I encourage all  
who have something to contribute to do so.  There are a few exceptions:

1.  News / Current Events
News is currently generated through sourceforge.net, and displayed via  
RSS feeds, so they are not editable on the wiki.

2.  Code
I'm terrible at regenerating the code documentation (via Doxygen),  
which doesn't fit in a wiki style format, so it tends to be out of date.

3.  User manuals
The manuals are released as PDFs.  Submissions and errata are accepted  
and incorporated.  Dean Hampton is currently working on bringing these  
into a wiki-style format for both collaboration and use as part of  
eGroupWare's Manual application.

Were you referring to one of these, or does that answer your question?

Nathan Gray
nathan at goarctic dot com


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Perp-developers mailing list
Perp-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/perp-developers

Re: Documentation sugestion

by Nathan Gray :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


On 26-May-08, at 6:15 PM, PCS-Lists wrote:

>
> Hi Nathan,
>
> I am talking about the manuals.
> Forget PDF and lets put them in wiki.
> I think it will be better for us.
>
> What do you think?

Personally, I don't care either way because I'm not the one who writes  
the manuals, I just upload them.
Corporately, it does not matter because our users never read the  
manuals anyway.

If you wish to maintain a wiki version of the user manuals, you are  
welcome to.
If you do not want to maintain a wiki version, I suggest that you  
start by expanding the errata section, which lists all the known  
differences between the PDFs and reality.

The PDFs will continue to be maintained and released as often as time  
allows.

Nathan Gray
nathan at goarctic dot com


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Perp-developers mailing list
Perp-developers@...
https://lists.sourceforge.net/lists/listinfo/perp-developers

Re: Documentation sugestion

by PCS-Lists :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Hi  Nathan,

everybody knows about "The RTFM problem".

Yes, I would like to try a Wiki manual version.

I think it is the best way for maintenance and translation.

How can you help me?
Where can I get original documentation?

TIA

Nathan Gray wrote:
On 26-May-08, at 6:15 PM, PCS-Lists wrote:

>
> Hi Nathan,
>
> I am talking about the manuals.
> Forget PDF and lets put them in wiki.
> I think it will be better for us.
>
> What do you think?

Personally, I don't care either way because I'm not the one who writes  
the manuals, I just upload them.
Corporately, it does not matter because our users never read the  
manuals anyway.

If you wish to maintain a wiki version of the user manuals, you are  
welcome to.
If you do not want to maintain a wiki version, I suggest that you  
start by expanding the errata section, which lists all the known  
differences between the PDFs and reality.

The PDFs will continue to be maintained and released as often as time  
allows.

Nathan Gray
nathan at goarctic dot com


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Perp-developers mailing list
Perp-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/perp-developers

Re: Documentation sugestion

by Nathan Gray :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


On 29-May-08, at 4:30 AM, PCS-Lists wrote:

>
> Hi  Nathan,
>
> everybody knows about "The RTFM problem". :-)
>
> Yes, I would like to try a Wiki manual version.
>
> I think it is the best way for maintenance and translation.
>
> How can you help me?
> Where can I get original documentation?

I can help by answering specific questions, and suggesting that you  
start a discussion with Tom.  He maintains the documentation in a  
company specific form which is not suitable for release to the public  
because it contains specific examples.  He subscribes to this list as  
well, and should be able to answer many of your questions.


Nathan Gray
nathan at goarctic dot com


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Perp-developers mailing list
Perp-developers@...
https://lists.sourceforge.net/lists/listinfo/perp-developers

Re: Documentation sugestion

by PCS-Lists :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Tom?

Are you reading this?
Can you help me?



Nathan Gray wrote:
On 29-May-08, at 4:30 AM, PCS-Lists wrote:

>
> Hi  Nathan,
>
> everybody knows about "The RTFM problem". :-)
>
> Yes, I would like to try a Wiki manual version.
>
> I think it is the best way for maintenance and translation.
>
> How can you help me?
> Where can I get original documentation?

I can help by answering specific questions, and suggesting that you  
start a discussion with Tom.  He maintains the documentation in a  
company specific form which is not suitable for release to the public  
because it contains specific examples.  He subscribes to this list as  
well, and should be able to answer many of your questions.


Nathan Gray
nathan at goarctic dot com


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Perp-developers mailing list
Perp-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/perp-developers

Re: Documentation sugestion

by PCS-Lists :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Tom?
Where are you?
I want to start a multi language documenntation in wiki.

Can help me?
Just for start, please.

TIA



Tom?

Are you reading this?
Can you help me?



Nathan Gray wrote:
On 29-May-08, at 4:30 AM, PCS-Lists wrote:

>
> Hi  Nathan,
>
> everybody knows about "The RTFM problem". :-)
>
> Yes, I would like to try a Wiki manual version.
>
> I think it is the best way for maintenance and translation.
>
> How can you help me?
> Where can I get original documentation?

I can help by answering specific questions, and suggesting that you  
start a discussion with Tom.  He maintains the documentation in a  
company specific form which is not suitable for release to the public  
because it contains specific examples.  He subscribes to this list as  
well, and should be able to answer many of your questions.


Nathan Gray
nathan at goarctic dot com


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Perp-developers mailing list
Perp-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/perp-developers


Re: Documentation sugestion

by Nathan Gray :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


On 15-Jun-08, at 8:53 AM, PCS-Lists wrote:

>
> Tom?
> Where are you?
> I want to start a multi language documenntation in wiki.
>
> Can help me?
> Just for start, please.

The documentation is being dumped into pERP's mediawiki at http://projecterp.org 
.

Everyone is welcome to help with reformatting for a wiki, translating,  
and further work on the documentation.

Nathan Gray
nathan at goarctic dot com


-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Perp-developers mailing list
Perp-developers@...
https://lists.sourceforge.net/lists/listinfo/perp-developers

Re: Documentation sugestion

by PCS-Lists :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Hi Nathan,

we start Brazilian Documentation.
http://www.projecterp.org/mediawiki/index.php/International_Documentation

Some points:
1- We need help in translation
2- We need help in study
3- We need help here: http://en.wikipedia.org/wiki/Diacritic
    This is VERY IMPORTANT in my language.
    See: http://www.projecterp.org/mediawiki/index.php/Menu_Brazilian_Documentation 

Can you help us in 3?

TIA

Nathan Gray wrote:
On 15-Jun-08, at 8:53 AM, PCS-Lists wrote:

>
> Tom?
> Where are you?
> I want to start a multi language documenntation in wiki.
>
> Can help me?
> Just for start, please.

The documentation is being dumped into pERP's mediawiki at http://projecterp.org 
.

Everyone is welcome to help with reformatting for a wiki, translating,  
and further work on the documentation.

Nathan Gray
nathan at goarctic dot com


-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Perp-developers mailing list
Perp-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/perp-developers

Re: Documentation sugestion

by Nathan Gray :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


On 21-Jul-08, at 4:35 PM, PCS-Lists wrote:

>
> Hi Nathan,
>
> we start Brazilian Documentation.
> http://www.projecterp.org/mediawiki/index.php/International_Documentation

Excellent, thank you.

> Some points:
> 1- We need help in translation
> 2- We need help in study

Sorry, other languages I can't help you with.

> 3- We need help here: http://en.wikipedia.org/wiki/Diacritic
>    This is VERY IMPORTANT in my language.
>    See:
> http://www.projecterp.org/mediawiki/index.php/Menu_Brazilian_Documentation
>
> Can you help us in 3?

What do you want me to do?
The page linked above is there, and I see both diacritics in 2.

Some links I found on interlanguage wikis:
http://meta.wikimedia.org/wiki/Help:Interwiki_linking#Interlanguage_link
http://en.wikipedia.org/wiki/Wikipedia:Interlanguage_links

pERP's wiki is a mediawiki, just like wikipedia, so anything you find  
about multilingualism and translation for wikipedia should apply.

Nathan Gray
nathan at goarctic dot com


-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Perp-developers mailing list
Perp-developers@...
https://lists.sourceforge.net/lists/listinfo/perp-developers

Re: Documentation sugestion

by PCS-Lists :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Hi Nathan,

I need you believe me, please.

We have a problem in this wiki.

I have changed FF 2 to FF 3.
Fedora 8 to Fedora 9.
No solutions.

I do not know Media wiki
I do not know about Portuguese and Media Wiki
I do not believe in ghosts.

See:

Link: http://www.projecterp.org/mediawiki/index.php/Introducao_ao_pERP

Compare My text:

=Introducao ao pERP=


O pERP, sigla de Project Enterprise Resource Planning (Projeto de Planejamento de Recursos da Empresa), e um software de  gestao financeira e controle de estoque.  O pERP integra as diversas areas de um a empresa, centralizando as informacoes de modo que elas podem ser livremente compartilhadas internamente. Por exemplo, o departamento de producao pode ver o que ha no inventario, o departamento de vendas pode ver o que esta na linha de producao, inclusive com prazos de conclusao, e o departamento de compras pode gerar automaticamente pedidos de compra baseados em pedidos agendados, níveis dos estoques existentes e prazos de entrega dos fornecedores.

O software esta agora em versao beta.  Isto significa que ele atingiu um estagio de desenvolvimento em que deveria estar amplamente livre de erros, executar corretamente a maioria das tarefas esperadas e estar pronto para receber dados reais.  O projeto esta longe de ser completo. Ha as funcionalidades basicas, mas alguns modulos ainda estao em inicio, o que significa que nao estao visualmente prontos ou faceis de usar. A documentacao esta bastante completa para alguns modulos e em fase de esboço para outros. Neste momento ela apenas responde ao "o que isto faz" e a um pouco de "como isto funciona". Cabe lembrar que esta documentacao nao pretende promover o treinamento de usuarios.

O pERP coordena um grupo de aplicacoes chamado egroupWare. Na sua forma atual, o pERP contem os seguintes modulos:
(Pode ser que nem todos os usuarios tenham acesso a todos os aplicativos desta lista.)

*''Contas a Pagar'' - Administra as informacoes de conta de fornecedores, gera e monitora pedidos de compra, organiza remessas de chegada, recebimento de mercadorias e pagamento de faturas de fornecedores.

*''Contas a receber'' - Cria contas de clientes associando informacoes como por exemplo filiais; organiza remessas de saída (basico), faturas de clientes e recebimento de pagamentos por pedidos de clientes.

*''Contabilidade Geral'' - atraves dele o departamento de contabilidade pode examinar e inserir transacoes, administrar contas bancarias (e eventualmente gerar uma variedade de relatorios).

*''Recursos Humanos'' - Gestao de Pessoal - analises e monitoramento de desempenho, relatorio de monitoramento de incidentes.

*''Inventario'' - monitora pecas e mercadorias prontas, opcoes de manufatura, monitora e administra níveis de estoque do inventario em varios locais, remessas de pecas entre estoques.

*''Manufatura'' - Cria demandas e lotes de demandas de trabalho, configura opcoes para mercadorias manufaturadas, cria e administra
listas de materia-prima.

*''Folha de Pagamento'' - Trabalha com dados da Planilha de Tempo para manipular todas as funcoes de folha de pagamento - deducoes, pagamento de ferias, emissao de cheques.

*''Pedidos de Venda'' - Cria complexas estruturas de aprecamento, cria e monitora pedidos de venda.


Alem disto, abaixo estao algumas das aplicacoes do [http://www.egroupware.org:8080/egroupware/index.php?menuaction=wiki.uiwiki.view&page=eGroupWare+applications eGroupWare], e o modo como o pERP os utiliza:

*''Contatos'' - Repleto de recursos!  todos os clientes, fornecedores e endereços internos sao armazenados aqui.

*''Administracao'' - Caminho pelo qual a equipe de TI configura os niveis de acesso, funcoes e informacoes basicas.

*''Agenda'' - Aliado a Contatos e Tarefas, a Agenda prove CRM - Customer Relationship Management (Administracao do relaciona

nto com o cliente),com links para o iCal.

*''Pagina inicial''

Destaca para o usuario as suas tarefas.  Por exemplo, o Gerente de Compras pode ver os Pedidos de  Compra que precisa aprovar. Um agente de compras poderia ver uma lista dos pedidos feitos para enviar e, finalmente a Contabilidade poderia ver uma lista dos pedidos de compra recebidos mas nao faturados pelos fornecedores.

*''Tarefas'' - Um meio de acompanhar informacoes relacionadas ao trabalho de cada um. - pendencias, chamadas telefônicas, afazeres etc.


*''Gerenciador de Projetos'' - Um meio de programar, acompanhar e orcar projetos.
 
*''Planilha de Tempo'' - Uma ferramenta para o monitoramento das horas de trabalho de funcionarios e projetos.

*''Fluxo de trabalho'' - Um fluxo de trabalho define um conjunto comum de passos-processos que devem ser seguidos por um certo tipo de trabalho.  O Fluxo de Trabalho do pERP garante que todos os passos sejam tomados (em uma certa ordem) e acompanha o progresso da tarefa ou produto ao longo da linha de producao.

''Quando o pERP estara pronto para a versao final?''

Os parâmetros de concepcao iniciais do projeto nunca foram claramente definidos, por isso nao ha um ponto onde se possa dizer "Aqui cumprimos as exigencias necessarias". Em vez disto, o pERP tem tido uma evolucao orgânica que e frequentemente revista, sempre que alguem pensa em alguma coisa a mais que precisa fazer.

A versao beta do pERP foi disponibilizada em Outubro de 2007 e tem sido utilizada mundialmente por varias companhias para diversas propostas em areas que nao a de manufatura.  

Ele provavelmente nunca atingira uma "versao final". O pERP ira continuar a mudar e crescer em resposta as sugestões de usuarios e com a solicitacao de novas funcoes.


[[Documentacao do Usuario]]


==='''Testando o pERP'''===




Thanks.



Nathan Gray wrote:
On 21-Jul-08, at 4:35 PM, PCS-Lists wrote:

>
> Hi Nathan,
>
> we start Brazilian Documentation.
> http://www.projecterp.org/mediawiki/index.php/International_Documentation

Excellent, thank you.

> Some points:
> 1- We need help in translation
> 2- We need help in study

Sorry, other languages I can't help you with.

> 3- We need help here: http://en.wikipedia.org/wiki/Diacritic
>    This is VERY IMPORTANT in my language.
>    See:
> http://www.projecterp.org/mediawiki/index.php/Menu_Brazilian_Documentation
>
> Can you help us in 3?

What do you want me to do?
The page linked above is there, and I see both diacritics in 2.

Some links I found on interlanguage wikis:
http://meta.wikimedia.org/wiki/Help:Interwiki_linking#Interlanguage_link
http://en.wikipedia.org/wiki/Wikipedia:Interlanguage_links

pERP's wiki is a mediawiki, just like wikipedia, so anything you find  
about multilingualism and translation for wikipedia should apply.

Nathan Gray
nathan at goarctic dot com


-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Perp-developers mailing list
Perp-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/perp-developers

Re: Documentation sugestion

by Nathan Gray :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


On 31-Jul-08, at 4:20 PM, PCS-Lists wrote:

>
> Hi Nathan,
>
> I need you believe me, please.
>
> We have a problem in this wiki. ...
> Link: http://www.projecterp.org/mediawiki/index.php/Introducao_ao_pERP
>
> Compare My text:
>
> =Introducao ao pERP=
>
>
> O pERP, sigla de Project Enterprise Resource Planning (Projeto de
> Planejamento de Recursos da Empresa), e um software de  gestao  
> financeira e
> controle de estoque.  O pERP integra as diversas areas de um a  
> empresa,
> centralizando as informacoes de modo que elas podem ser livremente
> compartilhadas internamente. Por exemplo, o departamento de producao  
> pode
> ver o que ha no inventario, o departamento de vendas pode ver o que  
> esta na
> linha de producao, inclusive com prazos de conclusao, e o  
> departamento de
> compras pode gerar automaticamente pedidos de compra baseados em  
> pedidos
> agendados, níveis dos estoques existentes e prazos de entrega dos
> fornecedores.


Ok, that helps.
Definitely something strange going on there, but I have no ideas.  
I'll discuss with our system admin in the next week and we'll see if  
we can figure out what's happening.  I note that your sample text,  
above, has no diacritics for the first half or so.  Do you know if  
it's the diacritics that cause the strangeness?  I.E.  If you make a  
page with no diacritics, does it work the way it should?

Nathan Gray
nathan at goarctic dot com


-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Perp-developers mailing list
Perp-developers@...
https://lists.sourceforge.net/lists/listinfo/perp-developers
LightInTheBox - Buy quality products at wholesale price