1.Introduccin Ladocumentacindesistemaseselconjuntodeinformacinquenosdicequhacenlos sistemas,cmolohacenyparaquinlohacen. Ladocumentacinconsisteenmaterialqueexplicalascaractersticastcnicasylaoperacin deunsistema.Esesencialparaproporcionarentendimientodeunsistemaaquienlovayaa usarparamantenerlo,parapermitirauditoriadelsistemayparaensearalosusuarioscomo interactuarconelsistemayalosoperandoscomohacerlofuncionar. Existenvariostiposdedocumentacin.Ladeprogramas,queexplicalalgicadeunprograma eincluyedescripciones,diagramasdeflujo,listadosdeprogramasyotrosdocumentosladel usuariosenformagenerallanaturalezaycapacidadesdelsistemaycmousarlo. Muchasorganizacionestienenloqueseconocecomoun"programadedocumentacin",elcual consisteenunapolticaformalcuyadocumentacinsemuestracomoalgoquedebe prepararseenformarutinariaparacadaprogramadecmputo,archivoynuevossistemas.

Otradefinicinseraladeregistrofsico,generalmenteporescritoquecontienelossiguientes elementos: Polticasynormasreferentesaldesarrollodelsistema,suimplantacin,operaciny mantenimiento. Eldiseodelsistemadeinformacinadministrativo. Procedimientosparainstalarelsistemadeinformacinadministrativo. Procedimientosparaoperarelsistemadeinformacinadministrativo. Procedimientosparamantenerelsistemadeinformacinadministrativo. ImportanciaDeLaDocumentacinDeSistemas Laimportanciadeladocumentacinbienpodrasercomparadaconlaimportanciadela existenciadeunaPlizadeSeguromientrastodovabiennoexistelaprecaucindeconfirmar sinuestraPlizadeSegurosestonovigente. Ladocumentacinadecuadaycompleta,deunaaplicacinquesedeseaimplantar,mantenery actualizarenformasatisfactoria,esesencialencualquierSistemadeInformacin,sinembargo, frecuentementeeslapartealacualsededicalmenortiempoyseleprestamenosatencin. SiempresedebedocumentarunsistemacomosiestuvieraapuntodeirseaSiberiael siguientemes,paranuncavolver.Siladocumentacindelsistemaesincompletaeldiseador continuamenteestarinvolucradoynopodrmoverseaotraasignacin. 2.Estandarizacionynormalizacion Estandarizacion Significaquelossmbolosconvencionalesseusanentodoslosdiagramasdeflujopara prescribirelsistemayqueenladocumentacinseusenformasestandarizadas. Ancuandolasnormasdedocumentacinvarandeunainstalacinaotra,esesencialque dentrodeunaorganizacin,seutiliceunsolomtodo.Elusodeprocedimientosy documentacinestandarizadaproporcionalabasedeunacomunicacinclarayrpida, adiestramientomenoscostosodelpersonaldesistemas,reduccindecostosde almacenamiento,yotros. VentajasDeLaEstandarizacion AyudaalentrenamientodelnuevopersonaldentroyfueradelaorganizacindeSistemas. Estilparacualquieraquetengalaresponsabilidaddelmantenimientodelossistemas.

Ayudaalosanalistasydiseadoresdesistemaseneltrabajodeintegracindesistemas. Aseguraqueelsistemaoperecorrectamente. Seutilizaneficientementelosrecursosquesedispongan. EstandaresBsicosDeDocumentacin Todadocumentacinqueserelacioneconunsistema,yaseamanualoporcomputadora, sencilloocomplejodebereunirlossiguientesrequisitosbsicos: Debeserrotuladaconclaridadybienorganizada,conseccionesclaramenteindicadas, almacenarlasencarpetasendice. Losdiagramasdebernserclaros,noaglomeradosylaescrituramanuscritadeberserlegible. Ladocumentacindebersercompleta. Seincluirunaleyendaoexplicacindelostrminosutilizados. Ladocumentacinsiempreseconservaactualizada. Normalizacin Asegresedequelosestndaresseancompletos,actualizados,documentadosylegibles. Auditarpermanentementeparaquesecumplanlosestndares. Evaluarsilosestndaresestablecidossonlosrequeridosyhacerloscambiosnecesariospara quedichosestndaresseanlosapropiados. TeoriaGeneralDeLosManualesDeDocumentacin Duranteeldesarrollodeunsistema,desdesuconcepcinhastasupuestaenmarchaseha generadograncantidaddedocumentos,queenmuchasocasionessehanvistomodificados pordocumentosposterioresdebidoacambiosenelsistema. Paraevitarconfusionesenlasrevisionesdeladocumentacinsedesarrollandiferentestiposde documentosdirigidosalaspersonasquetrabajarnconelsistemayparafacilitarel mantenimientodelmismo.Ladocumentacindeunsistemadebesermarcada adecuadamente,bienorganizadaactualizadaycompletatodoslostrminosutilizadosdeben explicarse.Ladocumentacinsehardisponibleatodoslosusuariosdcacuerdoasus necesidades. Elestiloderedaccindelosmanualesdedocumentacindebeser: Concreto. Serprecisoydefinirlostrminosutilizados. Utilizarprrafoscortos. Utilizarttulosysubttulos. Utilizarformasactivasenlugardepasivas. Noemplearfraseslargasquepresentenhechosdistintos. Nohacerreferenciaaunainformacinsolamenteconelnmerodereferencia 3.ManualAdministrativo SirvecomopuntodepartidaalSistemapropuesto,yaqueserfuncindelagerencia,de acuerdoconlosusuariosdedichoSistema,determinarsiloexpuestoenlsatisfacelos requerimientosdelpropiosistema.Unavezlogradalaaprobacin,seestarencondicionesde iniciareldesarrollodelSistemapropuestoeirintegrandoelrestodeladocumentacin. Elmanualtienecomofinalidadelpermitiralaaltagerenciatenerlainformacinnecesariay suficientesobreunsistemaenparticularyservircomofuentedcconsultaunavezqueel Sistemahasidoimplantado.

Contenido Nombredelsistema Describirelnombredelsistemaaimplantarenlaempresa. EquipoEncargadoDelSistema Nombredelpersonalencargadodelanlisisydiseodelsistema. ResumenAdministrativo Compendiodelopuntosquesedescribenenelmanual,elcualtienecomopropsitopermitira losaltosejecutivosenterarseenformasomeradelapropuestadelsistema.Enestepunto apareceporprimeravezelnombredelsistema,elcualdebesernico,estedeber conservarseinvariableentodoslosdocumentosreferentesaesesistema. Planteamiento Estepuntotienecomofinalidadregistrarlosantecedentesqueservirndepartidaaldesarrollo delanlisisdelsistema.Sedebemencionar: Dependenciaquerequirieltrabajo. Personasy/opuestosocupadosporestasalmomentoderequerirseeltrabajo(acuerdos, disposicioneslegales,memorandos,yotros) Condicionesycriteriosquenormaroneldesarrollodeltrabajo. Fechascorrespondientes. ObjetivosDelSistema Aqusedejarnestablecidoslosobjetivosquedebecubrirelsistema,enformaclarayprecisa paraevitarerroresdeinterpretacin. EntradasDelSistema(InformacinACaptar) Debequedarespecificadoenestepunto,losdocumentosfuentesqueinicianlasoperaciones delsistemaascomolainformacindetalladadeaquellosconceptosquesernlosdatosa captarporelsistema.Sedebernmencionartodoslosdatosqueenformasecundariaoriginan unaentradaimportantealsistema. Ejemplo: Nombredel DocumentoFuente Mduloo Procedimientodonde entraeldocumento Usuariosque manejanel documento Origendel documento

SalidasDelSistema(ResultadosAObtener) Enestepunto,solamentesedescribirnlosresultadosdemayorimportanciaobtenidosa travsdetodoelproceso.Enestaseccinsedebedarmayornfasisalainformacinqueel sistemaproporcionacuidandodenohacertanslomencindelosresultadosaobtener. Ejemplo: Nombredelasalida Destino Periodicidadenque segenera Usuariosquelo requieren

DiagramacionGeneralDelSistema EslarepresentacingrficadelasfasesdelSistemaysuflujoatravsdelasdependencias queintervienenenelmismo,aunqueenformageneralizada.Latcnicaautilizarylasimbologa debeserseleccionadaporlosinteresados.

ExplicacionesDeLasFasesDelSistema Estepuntoseencuentrarelacionadoconelanterioryaqueloquesemuestragrficamente, ahorasedescribeenformagenrica,explicandolosprocesosquesellevanacaboencada dependenciasinprofundizarendetallestcnicosoespecficos.Sedeberresaltaraquellas fasesdelprocesoenlasculesseobtenganresultadosdeimportanciaascomoaquellasque requieranunasupervisinespecial. RequerimientosDelSistema Seestablecenlosrecursos,tantohumanoscomomaterialesquesonnecesariosparapoder llevaracaboelsistema.Presentarcostosydescripcin,ademsdelascantidadesquese requieran. EstimacinDeLaFechaProbableDeImplementacionDelSistema Esnecesarioqueexistaunafechaprobabledeimplantacincuyabaseserlaterminacinde todaslasactividadesparalacreacindelsistema,talescomo:anlisis,programacin, elaboracindeformas,yotros. SerecomiendautilizardiagramadeGranttodePertparaestablecerelperododelas actividadesrequeridasparaeldesarrollodelsistema. Ejemplo: Escaladeltiempoensemanas Actividadesarealizar Presentacindela Propuesta Anlisis Costo/Beneficio Adquisicindel Equipo Entrenamiento 1 ***** 2 3 4

*****

*****

*****

ConsideracionesGeneralesDelNuevoSistema Enestepuntosedebersealarlasventajas,desventajas,yprincipalesdiferenciasdelnuevo sistemaconelanterior,talescmoseguridad,disminucindecosto,ahorrodetiempo, flexibilidad,confiabilidadyotros.Adems,desarrollarencualquieraspectodelapropuestadel sistemaquenofileconsideradoeneldesarrollodelospuntosantesmencionados. 4.ManualDeUsuario Exponelosprocesosqueelusuariopuederealizarconelsistemaimplantado.Paralograresto, esnecesarioquesedetallentodasycadaunadelascaractersticasquetienenlosprogramasy laformadeaccedereintroducirinformacin.Permitealosusuariosconocereldetalledequ actividadesellosdeberndesarrollarparalaconsecucindelosobjetivosdelsistema.Renela informacin,normasydocumentacinnecesariaparaqueelusuarioconozcayutilice adecuadamentelaaplicacindesarrollada. Objetivos

Queelusuarioconozcacmoprepararlosdatosdeentrada. Queelusuarioaprendaaobtenerlosresultadosylosdatosdesalida. Servircomomanualdeaprendizaje. Servircomomanualdereferencia. Definirlasfuncionesquedeberealizarelusuario. Informaralusuariodelarespuestaacadamensajedeerror. Pasosaseguirparadefinircomodesarrollarelmanualdeusuario. Identificarlosusuariosdelsistema:personalqueserelacionarconelsistema. Definirlosdiferentestipodeusuarios:sepresentanlosdiferentestiposdeusuariosqueusaran elsistema.Ejemplo:usuariosdirectos,indirectos. Definirlosmdulosenquecadausuarioparticipar:Sedescribenlosmdulosoprocesosque seejecutarnporcadausuarioenformanarrativabreveyclara. ImportanciaDelManualDeUsuario ElManualdeUsuariofacilitaelconocimientode: Losdocumentosalosquesepuededarentradaporcomputadora. Losformatosdelosdocumentos. Lasoperacionesqueutilizadeentradaysalidadelosdatos. Elordendeltratamientodelacomputadoraconlosdatosintroducidos. Elmomentoenquesedebesolicitarunaoperacindeseada. Losresultadosdelasoperacionesrealizadasapartirdelosdatosintroducidos. AlelaborarelManualdeUsuario,hayquetenerencuentaaquinvadirigidoesdecir,elmanual puedesermanejadodesdeeldirectordelaempresahastaelintroductordedatos.Por consiguiente,deberedactarsedeformaclaraysencillaparaqueloentiendacualquiertipode usuario. Contenido Diagramageneraldelsistema Muestraenformacondensadaelflujogeneraldelainformacinydelasactividadesquese realizanenelsistema.Proporcionaunavisingeneraldelsistema.Representarlosdiagramas utilizandoparaellodiagramasdebloques. Diagramaparticulardetallado. Presentargrficamentetodoslospasosqueseefectendentrodeldepartamentousuarioa quienestdirigidoestemanual.Debenespecificarselosarchivosdeentrada,salida,los resultados,revisionesyprocesosmanuales. ExplicacinGenricaDeLasFasesDelSistema Enestepuntoseexplicaenformaespecficaydetalladatodaslasoperacionesqueaparecen representadasenformagrficaeneldiagramaparticular.Seanalizancadaunadelasfases sealando: Elprocesoprincipalquesedesarrolla. Laentradadelainformacin. Laobtencindeunresultadoparcial. Elenvodeinformacinaotradependencia. InstalacinDelSistema Lainstalacindelsistemaproporcionadetallescompletossobrelaformadeinstalarelsistema

enunambienteparticular. IniciacinAlUsoDelSistema Enestepuntoseexplicacmoiniciarseenelsistemaycmosepuedenutilizarsuscualidades comunes.Estadocumentacindebedeciralusuariocmosalirdeunproblemacuandolas cosasfuncionanmal. ManualDeReferencia Eseldocumentodefinitivodecaraalusuarioydebesercompleto.Describecondetallelas cualidadesdelsistemaysuuso,losinformesdeerrorgeneradosylassituacionesenque surgenesoserrores. Dependiendodelsistema,losdocumentosalusuariosepuedenproporcionarporseparadoo reunidosenvariosvolmenes.Lossistemasdeayudaenlneaevitanqueelusuariopierda tiempoenconsultasmanuales. CaducidadDeDocumentoFuenteYDestinoFinal Comoelusuariotrabajarcondocumentosfuentes,stospodrntenerunperododeretencin yundestinoespecificado. 5.ManualDeCaptacion PermitetenerunaclaravisindelprocesodeCaptacindeloslatosfuentesprevioal procesamientoelectrnicodelosmismos. Objetivos Documentaralusuarioacercadelrecorridoatravsdelaspantallasdelsistema. Conocerlaformacmoelusuariopuedeutilizarelequiponecesarioparalaejecucindel sistema. Contenido DiagramaGeneralDelSistema Estediagramadebeserpresentadogrficamenteyenformasencilla.Representarlos diagramasutilizandoparaellodiagramasdebloques(eselmismodiagramaquesepresenta enelManualAdministrativo). DiagramasDePantalla Presentarenestepuntoelflujodelsistemaenlaspantallasutilizadasporcadamdulo. Puntosadocumentarenunapantalla: Explicacindelrecorridoparallegaralapantalla. Formatodelosdatosacaptar. Formatoenquesoncaptadoslosdatos. ExplicacinGenricaDeLasFasesDelSistema Esunaexplicacinclara,brevedetodoslosmdulosquesepresentaneneldiagramageneral. EquipoUtilizadoParaLaCaptacin Sedebecrearuninstructivoquepermitaalusuarioelentrenamientodelsistema. Debecontenerlossiguientespuntos: Usodelequipo: Describirdetalladamenteelusocorrectodelequipoutilizadoparalacaptacindelainformacin, dandounaexplicacindelencendido,manejo,controlydelmaterialqueseusacomomediode captacindelosdatos. EntrenamientodelSoftwaredelaaplicacin:

Explicacindelsoftwareutilizadoencomplementoalsistema. Ejemplo:comoentrarysalirdelsistema. SituacionesAnormales Sepresentanmensajesqueseemitenalmomentodelacapturadelosdatosocualquier condicinfueradclonormal.Ejemplo: Situacin anormal Mensaje Causas Soluciones

EntregasAlComputador Estableceruncalendarioconfechasdeentregaalcomputador,aligualqueunhorarioparala obtencinderesultados. Elcalendariodeterminamarcacundolasactividadesdebenllevarseacabodcmaneraquela gestindelsistemanoseveaafectado.Siesunsistemaenlneanoserequiere.Ejemplo: Operacin Solicitudde reporte Frecuencia Semanal Mensual Objetivo Actualizar informedel departamentoX HoradeEntrada Antesdelas2:00 p.m. Horadesalida 3:00p.m.

CaducidadDeDocumentosFuentes Establecerporescritolafechadecaducidaddelosdocumentosfuentes,elfinaquehande destinarseyaseaparasudestruccin,devolucinoconservacinenunarchivo. Manualdeoperacin Objetivo Contienelainformacinquepermitealpersonaldeoperacinutilizarenformaeficientela operacindelossistemasdeprocesamientoelectrnico. Contenido Diagramageneraldelsistema Estediagramadebeserpresentadogrficamenteyenformasencilla.Representarlos diagramasutilizandoparaellodiagramasdebloques(eselmismodiagramaquesepresentaen elManualAdministrativo). Diagramageneraldelflujodelprocesoelectrnico. Serepresentaenestediagramatodoelambienteperifricoqueinteractaenelsistemaen cuantoa:entradasmanuales,mediosmagnticosydispositivosdesalida.Lasimbologaa utilizardebeserestablecidacomoestndar.(Ejemplos:cintas,discos,disquetes). ExplicacinGenricaDeLasFasesDelSistema Esunaexplicacinclara,brevedetodoslosmdulosquesepresentanenelDiagramageneral descritoanteriormente. DiagramaDePantallasDelSistema Sepresentaenestepuntoelflujodelsistemaenlaspantallasutilizadasporcadamdulo. Puntosadocumentarenunapantalla: Explicacindelrecorridoenpantalla. Formatoenquesoncaptadoslosdatos.

InstruciwoDeOperacinPorPrograma Sedebedesarrollarporcadaprogramadclsistema.Incluye: Diagramaelectrnicodelprograma. Leerms:http://www.monografias.com/trabajos6/dosi/dosi.shtml#ixzz2fwJxzfYU